nav.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "description": "ナビゲーションの1つのまとまりです．上部ナビゲーションではプルダウンの根本に，下部ナビゲーションでは見出しのように表示されます．",
    "properties": {
      "name": {
        "type": "string",
        "description": "ナビゲーションのまとまりのタイトルです．"
      },
      "sitemap": {
        "type": "object",
        "description": "`/sitemap/` の生成に関する設定です．存在する場合はこの名前の見出しが生成され，`contents` の全ての項目の親となります．",
        "properties": {
          "section": {
            "type": "boolean",
            "description": "見出しに現れることを宣言します．"
          }
        },
        "required": ["section"]
      },
      "contents": {
        "type": "array",
        "description": "そのまとまりのナビゲーションの中身です．",
        "items": {
          "type": "object",
          "description": "ナビゲーションの1行です．",
          "properties": {
            "name": {
              "type": "string",
              "description": "ナビゲーションのタイトルです．Markdown+HTML形式で記述することができます．"
            },
            "url": {
              "type": "string",
              "description": "ナビゲーションのリンク先です．`/`から始めてください．"
            },
            "sitemap": {
              "type": "object",
              "properties": {
                "section": {
                  "type": "boolean",
                  "description": "見出しに現れるかどうかを指定します．`false` の場合，親の見出しの中に直接入ります．"
                },
                "parent": {
                  "type": "string",
                  "description": "親の見出しがどれかを指定します．"
                }
              }
            },
            "hidden": {
              "type": "boolean",
              "description": "ヘッダーとフッターには表示しない場合に指定します．"
            }
          },
          "required": ["name", "url"],
          "additionalProperties": false
        }
      }
    },
    "required": ["name", "contents"],
    "additionalProperties": false
  }
}