ツリー

ツリーとは

「ツリー」はドキュメントを構造化するための機能です。複数のドキュメントを組み合わせてアウトラインを作成したい場合に使用します。

ツリーの作成

リポジトリのルートに .hackersheet/trees というディレクトリを作成します。
.hackersheet/trees 以下に、後述の例のような内容のJSONファイルを保存します。
このファイルをプッシュすることでツリーが作成されます。

ツリー定義ファイルの例

ツリー定義ファイルの例を開く

ウェブサイト

Node.js

tree.json

{
  "name": "docs",
  "slug": "docs",
  "nodes": [
    {
      "name": "はじめに",
      "slug": "getting-started",
      "path": "docs/00-getting-started/00-index.md",
      "nodes": [
        {
          "name": "アカウントの作成",
          "slug": "signup",
          "path": "docs/00-getting-started/01-signup.md"
        }
      ]
    },
    {
      "name": "機能の紹介",
      "slug": "features",
      "path": "docs/01-features/00-index.md",
      "nodes": [
        {
          "name": "GitHub App",
          "slug": "github-app",
          "path": "docs/01-features/01-github-app.md"
        },
        {
          "name": "コンテンツリポジトリ",
          "slug": "github-repo",
          "path": "docs/01-features/02-github-repo.md"
        },
        {
          "name": "ワークスペース",
          "slug": "workspace",
          "path": "docs/01-features/03-workspace.md"
        },
        {
          "name": "ドキュメント",
          "slug": "document",
          "path": "docs/01-features/04-document.md"
        },
        {
          "name": "アセット",
          "slug": "asset",
          "path": "docs/01-features/05-asset.md"
        },
        {
          "name": "タグ",
          "slug": "tag",
          "path": "docs/01-features/06-tag.md"
        },
        {
          "name": "ウェブサイト",
          "slug": "website",
          "path": "docs/01-features/07-website.md"
        },
        {
          "name": "ツリー",
          "slug": "tree",
          "path": "docs/01-features/08-tree.md"
        }
      ]
    }
  ]
}