-
-
Notifications
You must be signed in to change notification settings - Fork 57
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
Migrate to Docusaurus frontmatter & change all heading levels to use markdown #9
Migrate to Docusaurus frontmatter & change all heading levels to use markdown #9
Conversation
Deploying with Cloudflare Pages
|
…s-Dev/Documentation into docusaurus-frontmatter
Well, I think I finished the work. For links, it will be better to do that in a separeted PR (for easy reviews), this PR is already big enough |
Why are we removing the titles and only sticking it in the metadata? We can just leave the title as is since it'll be consumed by the parser. The one I think should probably be in the metadata is the description if the first sentence doesn't accurately describe the page. |
Hey! Sorry for the delay for my reply. I did it out of reflex because I think it's more "cleaner" (as generally, front matters are used for page headers). But, if It's needed to change it, I can. |
All good. Though I think its better with the title since it stands out to me that I've clicked the correct page. Since we normally have a quick description of each page below the header, it makes sense to have it there imo. |
So I should use h1 for the title? |
Yep, wrote up a whole style guide if you need it: https://docs.neoforged.net/contributing#style-guide |
@ChampionAsh5357 It's changed ^^ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's not a file for this, but there likely needs to be a _category_.json
file at the top level to order the folders.
Directly in docs folder ? |
I believe either in root or the subfolders based on what I understand of the docs. It should be the same process of specifying the sidebar position. If there is an index file, it should just pass the sidebar position to the root. |
We could also change from an autogenerated solution to modifying the sidebars.js so that everyone doesn't have to modify the position of every file. |
I think it's the better solution ^^. |
Go for it. We'll probably need to change the contributing guidelines too to match that |
Resolve the merge conflicts and this should be good to go. We'll see when new pages are added whether autogenerated subfolders make sense, or if we should do it manually. |
Closing as completed by #65. |
https://docusaurus.io/docs/markdown-features#front-matter
https://docusaurus.io/docs/markdown-features#standard-features
Preview URL: https://pr-9.neoforged-docs-previews.pages.dev