Table of contents as JSON 

Every manual is rendered with a toc.json at its root: what pages there are, in the order the table of contents puts them and nested the way it nests them.

{
    "project": {
        "title": "TYPO3 Explained",
        "version": "main",
        "permalink": "https://docs.typo3.org/permalink/t3coreapi:{anchor}@main"
    },
    "pages": [
        {
            "path": "Index",
            "html": "Index.html",
            "md": "Index.md",
            "title": "TYPO3 Explained",
            "anchor": "api-overview",
            "pages": [
                {
                    "path": "Introduction/Index",
                    "html": "Introduction/Index.html",
                    "md": "Introduction/Index.md",
                    "title": "Introduction",
                    "anchor": "introduction"
                }
            ]
        },
        {
            "orphan": true,
            "path": "404",
            "html": "404.html",
            "md": "404.md",
            "title": "Content was removed",
            "anchor": "not-found"
        }
    ]
}

What the project says is said once, at the top:

title

The title of the manual.

version

The version it was rendered as, or "" for a manual that names none.

permalink

The permalink of every page at once: put a page's anchor where {anchor} is. "" for a manual that declares no interlink shortcode and therefore has no permalinks.

Each page carries only what is its own:

path

The page within the manual, relative to this file and without an extension: the name the page has in both of its forms. Works in a local render and under docs.typo3.org alike, as do the two links below.

html

The page's HTML, relative to this file: path with .html. Left out when the manual was not rendered to HTML page by page.

md

The page's Markdown, relative to this file: path with .md, and what an agent reading the manual should follow. Left out when the manual was not rendered to Markdown page by page.

title

The title of the page.

anchor

The label the page is known by: its own if it declares one, otherwise the id derived from its title. Fill it into the project's permalink.

pages

The pages this one's table of contents leads to, in its order. Left out where there are none.

orphan

Present and true on a page no table of contents leads to. Listed all the same, because the file is published, and a table of contents that silently drops published pages is worse than one that says where they stand.