gpac / wiki

GPAC's wiki, the entrypoint to MP4Box and GPAC documentation.
https://wiki.gpac.io
GNU Lesser General Public License v2.1
0 stars 3 forks source link

hook to fix markdown titles should not modify code comments #8

Open nlsdvl opened 2 months ago

nlsdvl commented 2 months ago

having h1 titles in doc pages breaks the right sidebar navigation menu, see this issue for context.

In order to work around this limitation without modifying all content (some of which is autogenerated by gpac), a simple hook is used: https://github.com/gpac/wiki/blob/master/scripts/mkdocs_hooks.py#L218

However that hook doesn't differentiate markdown heading from code lines commented out in code blocks, see this python example : https://wiki.gpac.io/Howtos/python/#callbacks-in-blocking-sessions

There are only a few occurrences of this problem across the wiki as it currently contains very few code examples such as this one.