Document `#` headers being stripped from READMEs on Pursuit

purescript / pursuit

Website for hosting and searching PureScript API documentation

https://pursuit.purescript.org/

Other

170 stars 47 forks source link

Document `#` headers being stripped from READMEs on Pursuit #427

Open ursi opened 3 years ago

ursi commented 3 years ago

I just realized the # headers on my README are not being displayed on pursuit. GitHub Pursuit

hdgarrood commented 3 years ago

Yes, this is by design. Usually the h1 headings, ie those introduced by a single #, contain the library name; we remove them in Pursuit because otherwise it would be duplicated. You shouldn’t really have more than one of those per file. You can fix this by just demoting each heading: each # should become ##, each ## should become ###, and so on.

ursi commented 3 years ago

I see, is this behaviour documented anywhere?

hdgarrood commented 3 years ago

It’s not, unfortunately. There’s a help page for package authors here: https://pursuit.purescript.org/help/authors which would be the place to put it.