Items

Each item consists of the following keys:

title - the title of the item. It will be used in the sidebar;
type - the type of the item. It can be row - a regular item, and heading - a heading item, which will be bold text;
href - the link where the current item will be accessible. The link is specified fully except for the basePath. If no link is provided, it will be displayed as plain text;
configuration - the configuration of the current subtree (read more about configuration);
items - the subtree items of the current item.

Manual Generation

Firstly, Robindoc reads the structure passed as an argument:

TypeScript

JavaScript

export const { Page, Sidebar } = initializeRobindoc({
  // ...
  items: [
    {
      title: "Introduction",
      type: "heading",
      href: "/",
      configuration: {
        sourceRoot: "..",
      },
    },
    // ...
    {
      title: "Structure",
      type: "heading",
      href: "/02-structure",
      items: [
        // ...
        {
          title: "Data Source",
          href: "/02-structure/03-data-source",
        },
      ],
    },
    {
      title: "Elements",
      type: "heading",
      href: "/01-elements",
      items: "auto",
    },
  ],
});

export const { Page, Sidebar } = initializeRobindoc({
  // ...
  items: [
    {
      title: "Introduction",
      type: "heading",
      href: "/",
      configuration: {
        sourceRoot: "..",
      },
    },
    // ...
    {
      title: "Structure",
      type: "heading",
      href: "/02-structure",
      items: [
        // ...
        {
          title: "Data Source",
          href: "/02-structure/03-data-source",
        },
      ],
    },
    {
      title: "Elements",
      type: "heading",
      href: "/01-elements",
      items: "auto",
    },
  ],
});

You can also pass an asynchronous callback as an argument. In this case, you can form the structure in a way that suits you.

TypeScript

JavaScript

export const { Page, Sidebar } = initializeRobindoc(async () => {
  const items = await loadItems();

  return {
    configuration: {
      sourceRoot: "../docs",
      basePath: "/docs",
      gitToken: "YOUR_TOKEN",
    },
    items,
  };
});

export const { Page, Sidebar } = initializeRobindoc(async () => {
  const items = await loadItems();

  return {
    configuration: {
      sourceRoot: "../docs",
      basePath: "/docs",
      gitToken: "YOUR_TOKEN",
    },
    items,
  };
});

This configuration determines the list of available and generated pages, all links, the sidebar tree, etc.

Automatic Generation

To have the subtree generated automatically, you need to pass items: 'auto'.

TypeScript

JavaScript

export const { Page, Sidebar } = initializeRobindoc({
  // ...
  items: "auto",
});

export const { Page, Sidebar } = initializeRobindoc({
  // ...
  items: "auto",
});

You can add extra elements from third-party sources to automatically generated elements - items: [YOUR_OPTIONS, 'auto']

TypeScript

JavaScript

import { initializeRobindoc } from "robindoc";

export const { Page, Sidebar } = initializeRobindoc({
  configuration: {
    sourceRoot: "../docs",
    basePath: "/docs",
  },
  items: [
    {
      title: "Introduction",
      type: "heading",
      href: "/",
      configuration: {
        sourceRoot: "../README.md",
      },
    },
    "auto",
  ],
});

import { initializeRobindoc } from "robindoc";

export const { Page, Sidebar } = initializeRobindoc({
  configuration: {
    sourceRoot: "../docs",
    basePath: "/docs",
  },
  items: [
    {
      title: "Introduction",
      type: "heading",
      href: "/",
      configuration: {
        sourceRoot: "../README.md",
      },
    },
    "auto",
  ],
});

When generated automatically, the elements will be sorted in alphabetical order. In some cases, you can change the order by adding a number at the beginning (01-installation.md, 02-writing-md.md, 03-initialization.md), it will be automatically removed from the page path (/installation , /writing-md, /initialization).

This, like any configuration setting, can be done anywhere in the structure.

TypeScript

JavaScript

export const { Page, Sidebar } = initializeRobindoc({
  // ...
  items: [
    {
      title: "Structure",
      type: "heading",
      href: "/02-structure",
      items: [
        // ...
        {
          title: "Data Source",
          href: "/02-structure/03-data-source",
        },
      ],
    },
    {
      title: "Elements",
      type: "heading",
      href: "/01-elements",
      items: "auto",
    },
  ],
});

export const { Page, Sidebar } = initializeRobindoc({
  // ...
  items: [
    {
      title: "Structure",
      type: "heading",
      href: "/02-structure",
      items: [
        // ...
        {
          title: "Data Source",
          href: "/02-structure/03-data-source",
        },
      ],
    },
    {
      title: "Elements",
      type: "heading",
      href: "/01-elements",
      items: "auto",
    },
  ],
});

In automatic mode, Robindoc first looks for a structure.json file in the current directory.

If the structure.json file is not in the current directory, Robindoc will try to create the structure on its own based on the files in the directory. In this case, it will determine all paths, slugs, as well as the header for the sidebar link. The header is formed according to the same principles as the meta-header. Learn more about getting metadata on the Get Meta page.

structure.json

structure.json - a file with basic instructions for the current level of documentation. It is stored next to the markdown documentation files.

{
  "index": {
    "title": "Blog"
  },
  "updates": {
    "title": "Updates"
  },
  "tutorials": {
    "title": "Tutorials"
  }
}

For each structure element, Robindoc will repeat the process and check if there is a structure.json file. If so, it will include them in the final structure. This continues until no more files are left down the tree.

Previous
Configuration Next
Data Source