problems with page jump links, like in TOC, and special chars

justinwalsh / daux.io

Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.

4.54k stars 526 forks source link

I've notices some problems with page jump links and special chars. For example, having a headline like this:

# TEST : Test

Will generate an h1 element like this:

<h1 id="page_TEST+%3A+Test">TEST : Test</h1>

So the link, genereated by TOC is also escape the : chart to %A3:

#page_TEST+%3A+Test

But such jump links don't work with special char escaping. It should be used a generation like GitHub uses it. So the above example would result in #test-test, all lower case and separated by -, specialchars will be ignored completly.

justinwalsh / daux.io

problems with page jump links, like in TOC, and special chars #461