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

Generated markdown pages don't have a title #66

Open
thomasvl opened this issue Sep 8, 2020 · 2 comments
Open

Generated markdown pages don't have a title #66

thomasvl opened this issue Sep 8, 2020 · 2 comments

Comments

@thomasvl
Copy link
Member

thomasvl commented Sep 8, 2020

It looks like the markdown pages never get a page title (# TITLE line), so the documented symbol gets a heading marking (## SYMBOL_NAME), and thus becomes the page title. So when the page has a few symbols things are a little odd when rendered by most markdown engines.

I'm not sure if #25 would be the way to fix this or if the intent is for everyone to use a custom template for every generated page.

@larsrc-google
Copy link

Could you clarify which pages you're talking about?

@thomasvl
Copy link
Member Author

thomasvl commented Sep 14, 2020

Sent you an email directly. I'm not sure if you can see the result of this on github without pushing the generated md files to something like a github wiki. The first heading marked entry on a page (# TITLE) is used as the page title. Since nothing generated alike that, the first ## DOCUMENTED_API is what ends up as the title.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants