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

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

Closed
aamir1995 opened this issue Sep 15, 2023 · 2 comments
Labels
next Fix available in the '@next' release

Comments

@aamir1995
Copy link

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
Copy link
Member

tgreyuk commented Sep 15, 2023

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

@tgreyuk tgreyuk added the next Fix available in the '@next' release label Sep 15, 2023
@tgreyuk
Copy link
Member

tgreyuk commented May 3, 2024

@tgreyuk tgreyuk closed this as completed May 3, 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