Navigation

Each branch in the repository contains a toc.json file that defines the navigation structure.

{
    "title": "Getting Started",
    "pages": [
        "installation",
        "upgrade-guide",
        "compatability",
        {
            "name": "Pretty URLs",
            "file": "pretty-urls"
        },
        {
            "name": "Release Notes",
            "link": "https://github.com/anodyne/nova3/releases"
        }
    ]
},

Each object in the JSON file represents a section in the sidebar navigation. Each object should contain a title key that will be the text shown at the top of the section in the sidebar navigation.

Within each section is a pages key that's a simple array of the links that should appear in that section.

There are 3 ways to define pages for a section:

1. You can just provide the name of the file. If only a filename is provided, the site will take the filename and transform it into a link name.
   • installation will be transformed into Installation.
   • With compound filenames, it will add the necessary spaces and capitalize each word. upgrade-guide will be transformed into Upgrade Guide.
2. Sometimes a compound filename will result in a link name that's not exactly what you want. For example, pretty-urls would be transformed into Pretty Urls. To provide a custom link name, you can define an object that includes name and file keys to exert more control over the sidebar navigation links.
3. Sometimes links to external resources need to be provided. In those situations, you can define an object that includes name and link keys to provide a link to an external site.