HermanMartinus / bearblog

Free, no-nonsense, super fast blogging.
MIT License
2.36k stars 73 forks source link

Update docs on internal linking #244

Open Cwpute opened 11 months ago

Cwpute commented 11 months ago

Did a bit of internal linking for my blog, and had a difficult time understanding how it worked. You have currently two articles talking about it: Anatomy of a post and Navigation. The former has partial information about how it all works, compared to the second, which still lacks some critical information i had to research myself.

The informations that were lacking were about subheaders and internal link formatting, which were both consisely explained here: image

First, i'd suggest that the section in Anatomy of a post talking about links should provide a shortcut to Navigation for explaination in more details, and second, that you include the above missing informations i had struggle with in Navigation.

Thanks !