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

Publish typedoc #312

Open
lpatiny opened this issue Feb 7, 2022 · 2 comments
Open

Publish typedoc #312

lpatiny opened this issue Feb 7, 2022 · 2 comments

Comments

@lpatiny
Copy link
Contributor

lpatiny commented Feb 7, 2022

I would like to be able to add links from the docusaurus documentation to the react component in order to easily describe all the allowed props from all the components.

How could we publish automatically the typedoc and the storybook ?

typedoc on gh-pages and storybook on netlify ?

@stropitek
Copy link
Contributor

You might want to consider using https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc and host the regular documentation and the types documentation both in docusaurus

@targos
Copy link
Member

targos commented Feb 14, 2022

I still have to look into API Extractor (instead of typedoc). It would be nice because its output is already markdown.

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

3 participants