Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add package documentation preview #47

Open
difosfor opened this issue Feb 6, 2024 · 1 comment
Open

Add package documentation preview #47

difosfor opened this issue Feb 6, 2024 · 1 comment

Comments

@difosfor
Copy link

difosfor commented Feb 6, 2024

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.

@difosfor
Copy link
Author

difosfor commented Feb 6, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant