Docusaurus.io

Repository: https://github.com/flayyer/integration-examples/tree/main/examples/docusaurus

This documentation site is built with Docusaurus v2, so you can also refer to this source code to see a production example.

This plugin requires Docusaurus v2. There is no support for v1.

Yarn
NPM

Install @flayyer/docusaurus-preset:

Terminal.app

yarn add @flayyer/docusaurus-preset

On your docusaurus.config.js add @flayyer/docusaurus-preset at the end of your presets array:

{
  // ...
  presets: [
    // ...
    [
      "@flayyer/docusaurus-preset",
      {
        // Use this for the root "/"
        main: { tenant: "flayyer", deck: "flayyer-docs", template: "page" },
        // Use this flayyer for individual documentation pages
        docs: {
          tenant: "flayyer",
          deck: "flayyer-docs",
          template: "page",
          variables: {
            // Enable variable replacement
            title: "{{id}} - {{title}}",
            description: "{{description}}",
            static: "Plain hardcoded string",
          },
        },
        // Use this flayyer for individual blogpost pages
        blog: {
          tenant: "flayyer",
          deck: "flayyer-docs",
          template: "page",
          // Pick values form the context
          variables: ["title", "description"],
        },
      },
    ],
  ],
}