Organization using a table of contents file - Fluid Topics - Latest

Markdown Connector Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

The table of contents file (or toc.yml) allows content publishers to define the hierarchy of topics in a Markdown document using a single YAML file.

Users must name the file toc.yml (the extension must not be .yaml), and place it at the root of the archive.

Example:

toc:
  - filepath: "introduction.md"
    children:
      - filepath: "another_topic.md"
        children:
          - filepath: "nested_topic.md"
          - filepath: "last_nested_topic.md"
  - filepath: "api.md"
metadata:
  - key: "ft:originId"
    value: "a_test_toc_yml_doc"
  - key: "ft:title"
    value: "A test toc.yml document"
  - key: "Region"
    value: 
      - ["Europe", "France", "Provence-Alpes-Côte d'Azur"] # These values are hierarchical
  - key: "Versions" # The following values are NOT hierarchical. They are at the same level
    value: 
      - "1.0"
      - "2.0"

The toc.yml file must include the ft:originId and ft:title keys, with valid values.

This file produces a document with the following table of contents:

Title 

1. Introduction
  a. Another topic
    i. Nested topic
    ii. Last nested topic
2. API

The document and all topics receive the following metadata values:

Region: Europe > France > Provence-Alpes-Côte d'Azur
Versions: 1.0, 2.0

It is not possible to control whether topics inherit the metadata keys of the document.

For an example, select the Attachments button, and download the Markdown-test-toc-yml-doc.zip archive.