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

Whether typedoc can generate Markdown files according to the directory structure #353

Closed
He110te4m opened this issue Sep 23, 2022 · 1 comment
Labels
next Fix available in the '@next' release

Comments

@He110te4m
Copy link

I'm writing Vue 3's Component Library, which has some hooks (the TS function) . The comments within the component are parsed by the AST and extracted into a Markdown file that is rendered by VitePress, which is generated according to the directory structure. However, when Typedoc is generated, it prints everything to a file. This is very difficult to process and display in a component library.

Whether typedoc can generate Markdown files according to the directory structure?

@tgreyuk tgreyuk added the next Fix available in the '@next' release label Jan 22, 2023
This was referenced Jan 22, 2023
@tgreyuk
Copy link
Member

tgreyuk commented May 4, 2024

Version 4 has some additional output options which should hopefully fit most usecases. https://www.typedoc-plugin-markdown.org/docs/options#output-options .

@tgreyuk tgreyuk closed this as completed May 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
next Fix available in the '@next' release
Projects
None yet
Development

No branches or pull requests

2 participants