-
Notifications
You must be signed in to change notification settings - Fork 156
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
Render h1 from markdown #309
Comments
I fully agree, it was quite weird to have the first H1 not rendered. |
What should happen is that the H1 fills the frontmatter title if it's empty. Same for description with first paragraph. By default it should always be displayed. Maybe this could be an option from theming, but for now I think everything from the .md file should definitely be displayed. |
Is this still valid? |
I believe so, we need to do it before release nuxtjs.org with Docus yes. Also, I think we should not use the bloquote but the first paragraph for filling the front-matter description. |
Currently Docus treat
h1
separate from other content https://github.com/nuxtlabs/docus/blob/main/src/defaultTheme/components/organisms/PageContent.vue#L12-L37This could be confusing and unexpected. Maybe we should rethink this approach, and render
h1
along with other markdown content. This is expected, and also it doesn't have additional mental load on were to search where renderedh1
was placed in template.We can still use it for frontmatter, just change rendering part.
I believe this will affect current template, so it also will need a rethink.
The text was updated successfully, but these errors were encountered: