Skip to content

Outline specification

Jump to bottom
Ion Gireada edited this page Jan 16, 2020 · 3 revisions

Outline as object

var outline = {
   "project": "Documentation project title",
   "topics": [
       {
           "title": "Getting started",
           "brief": "This content appears as the first paragraph following topic title. It provides a topic brief description.",
            "headers": [
                 {
                     "title": "Installation",
                     "brief": "Provide clear installation instructions. Specify sub-headers in a headers property.",
                      "headers": [
                           {
                               "title": "Installation sub-header 1",
                               "brief": "It appears as an object in Installation's headers array property."
                           }
                      ]
                 }
            ]
       },
       {
            "title": "Specifying children topics",
            "brief": "To add topics as children to a topic, add the `topics` property.",
            "topics": [
                {
                    "title": "Child topic 1"
                },
                {
                    "title": "Child topic 2"
                }
            ]
       }
   ]
}

Outline as YAML 

project: Documentation project title
topics:
   - title: Getting started
     brief: This content appears as the first paragraph following topic title. It provides a topic brief description.
     headers:
        - title: Installation
          brief: Provide clear installation instructions. Specify sub-headers in a headers property.
          headers:
             - title: Installation sub-header 1
               brief: It appears as an object in Installation's headers array property.

   - title: Specifying children topics
     brief: To add topics as children to a topic, add the `topics` property.
     topics:
        - title: Child topic 1
        - title: Child topic 2

Clone this wiki locally