Tools

When initializing Robindoc, in addition to the core elements, you will also receive special utilities.

These utilities work based on the structure and documentation files. They are needed to fine-tune page generation. For more details on page configuration, refer to the App Organization page.

import { initializeRobindoc } from "robindoc";

export const { Page, Sidebar, getStaticParams, getMetadata, getPageData } =
  initializeRobindoc({
    configuration: {
      sourceRoot: "../docs",
      basePath: "/docs",
      gitToken: "YOUR_TOKEN",
    },
    items: "auto",
  });

import { initializeRobindoc } from "robindoc";

export const { Page, Sidebar, getStaticParams, getMetadata, getPageData } =
  initializeRobindoc({
    configuration: {
      sourceRoot: "../docs",
      basePath: "/docs",
      gitToken: "YOUR_TOKEN",
    },
    items: "auto",
  });

For more information on using the utilities, refer to their respective pages - getMetadata, getStaticParams, getPageData.