typedoc2md / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://typedoc-plugin-markdown.org
MIT License
697 stars 173 forks source link

[docusaurus-plugin-typedoc]: add the ability to add a separate frontmatter for readme file. #469

Closed aamir1995 closed 3 months ago

aamir1995 commented 11 months ago

Readme is an essential part of the documentation, sometimes it serves as the main page for docs, I want to add a separate frontmatter for a readme file, such as hiding the title, toc, and navigation, currently there's no way to do this only for the readme file, the frontmatter property applies to all the generated files.

It would be great if we had a way of specifying a separate set of standard frontmatter only for the readme. It could look something like this

readmeFrontmatter: {
 // standard docusasrus frontmatter here
}

Thanks!

tgreyuk commented 11 months ago

ok sure. the next release will treat frontmatter slightly differently but I'll add details how to do this.

tgreyuk commented 3 months ago

https://typedoc-plugin-markdown.org/plugins/frontmatter/options#readmefrontmatter