Skip to content
  • Nicola Fontana's avatar
    6d66773b
    Add automatic TOC to README.md · 6d66773b
    Nicola Fontana authored
    Manually maintaining the table of contents relies on how HTML fragments
    are generated, it is prone to errors (infact it is already out of sync)
    and just plain boring.
    
    Unfortunately there is no common agreement on all markdown flavours on
    how the table of contents must be implemented. Here the `[[_TOC_]]` tag
    has been used because it is supported by both GitLab and GitHub:
    
        gitlab-org/gitlab#21901
    6d66773b
    Add automatic TOC to README.md
    Nicola Fontana authored
    Manually maintaining the table of contents relies on how HTML fragments
    are generated, it is prone to errors (infact it is already out of sync)
    and just plain boring.
    
    Unfortunately there is no common agreement on all markdown flavours on
    how the table of contents must be implemented. Here the `[[_TOC_]]` tag
    has been used because it is supported by both GitLab and GitHub:
    
        gitlab-org/gitlab#21901
Loading