Search code examples
docusaurus

In Docusaurus, is there can I preserve capitalization in anchors created from headings in docs?

I'm using Docusaurus to publish documentation for an open source library's API. The headings of my source markdown files correspond to the names of methods and properties for classes in the library. This all works fine.

However, the anchors that are created in the HTML are all lowercase. I want them to respect the capitalization used in the markdown file.

For example, this markdown header:

###.doSomething()

Generates the following HTML:

<h3>
    <a aria-hidden="true" tabindex="-1" class="..." id="dosomething"></a>. 
    <code>.doSomething()</code>
    <a class="..." href="#dosomething" title="...">#</a>
</h3>

As you can see, camelCase is transformed to lowercase. I would like to keep capitalization intact. Is it possible?

P.S. The markdown files are automatically generated from jsdoc comments. In jsdoc, links to a method or properties include capitalization.

Solution

  • It turns out that you can simply use explicit IDs to solve this issue: https://docusaurus.io/docs/next/markdown-features/headings#explicit-ids