Skip to content

Add package documentation preview #47

@difosfor

Description

@difosfor

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions