Docusaurus Map Reference

You can use a regular DITA map to publish content with Docusaurus.

Note: Docusaurus only supports the standard DITA maps. Other DITA map types like bookmaps, learning maps, sitemaps, or specialized maps are not supported.

Map Structure

<map id="ditamap-465" title="Map A">
    <topicref href="t1.dita">
        <topicref href="t2.dita">
            <topicref href="t3.dita"/>
        </topicref>
    </topicref>
    <topichead navtitle="Topic Head A">
        <topicref href="t4.dita"/>
        <topichead navtitle="Topic Head B">
            <topicref href="t5.dita"/>
            <topicref href="t6.dita"/>
        </topichead>
    </topichead>
    <mapref format="ditamap" href="sm1.ditamap"><data href="t7.dita" name="" scope="local" value=""/></mapref>
</map>
Sample map structure

Sample Output

Sample output screenshot
  • Each topic that is a direct child of the publication map (see “Topic A”) is added to the left Table of Contents (TOC).
  • Each topic nested under a topic that is a direct child of the publication map is chunked (“Topic C” and “Topic B” are chunked to “Topic A”). In other words, every child of a topic reference element is chunked.
  • Each topic nested directly under a topic that is a direct child of the publication is added to the right TOC.
  • Each topic head element is rendered as an expandable item in the left TOC.
    Important: You can nest a topic head element under a topic head element (“Topic Head B” is nested under “Topic Head A”). You cannot nest a topic head element under a topic reference element.
  • Submaps do not impact the TOC structure (see “Submap A” and “Topic G”).