You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently it seems like this is just a service. I do see mention of running it locally, but then you need to install redis as well. And also I imagine it will also only work with published NPM packages.
I want a way to preview what the generated documentation will look like while I'm working on my code, before publishing it.
E.g. something like a tsdocs-preview NPM package that you can add as a dev dependency to your project to be able to run a server that shows you the docs generated based on the files in your local repo checkout.
Or perhaps it would be even better if there was like a tsdocs-cli NPM package that enables you to locally generate the related HTML etc or perhaps even alternatively MD. That way that could alternatively also be included within NPM packages. But also it would enable previewing your tsdoc based documentation.
The text was updated successfully, but these errors were encountered:
PS: I like what you've made; it looks really nice and could work really well in theory for all of us TypeScript NPM publishers. But because the service is still regularly slow or even unusable I find that we can't rely on it. And this lack of preview has already resulted in me publishing a package with unusable documentation.
I guess I'm going to give typedoc-plugin-markdown another try; this time combined with concat-md to turn it into a single file to make it easier to redistribute from our NPM packages through our docsify page.
Currently it seems like this is just a service. I do see mention of running it locally, but then you need to install redis as well. And also I imagine it will also only work with published NPM packages.
I want a way to preview what the generated documentation will look like while I'm working on my code, before publishing it.
E.g. something like a tsdocs-preview NPM package that you can add as a dev dependency to your project to be able to run a server that shows you the docs generated based on the files in your local repo checkout.
Or perhaps it would be even better if there was like a tsdocs-cli NPM package that enables you to locally generate the related HTML etc or perhaps even alternatively MD. That way that could alternatively also be included within NPM packages. But also it would enable previewing your tsdoc based documentation.
The text was updated successfully, but these errors were encountered: