snosov1 / toc-org

toc-org is an Emacs utility to have an up-to-date table of contents in the org files without exporting (useful primarily for readme files on GitHub)
GNU General Public License v3.0
293 stars 30 forks source link

markdown example should include ! #89

Closed masukomi closed 1 year ago

masukomi commented 1 year ago

in the readme it suggests you need to add <-- :TOC: --> to your header. The problem with this is that you end up with a big <-- :TOC --> displayed in your header. The plugin works if you make it an html comment <!-- :TOC: --> which is hidden (as desired) when you render the markdown.

ask: update the readme to include the ! so that people know they can do that instead.

snosov1 commented 1 year ago

Done

Not sure what I was thinking when I wrote this =)