stardoc icon indicating copy to clipboard operation
stardoc copied to clipboard

Generated markdown pages don't have a title

Open thomasvl opened this issue 4 years ago • 2 comments

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.

thomasvl avatar Sep 08 '20 17:09 thomasvl

Could you clarify which pages you're talking about?

larsrc-google avatar Sep 14 '20 10:09 larsrc-google

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.

thomasvl avatar Sep 14 '20 12:09 thomasvl