FAQs for Docusaurus

A Docusaurus plugin that builds a categorised FAQ page from local YAML files.

Full documentation →

Installation

npm install @homotechsual/docusaurus-plugin-faqs
# or
yarn add @homotechsual/docusaurus-plugin-faqs

Quick start

import faqsPlugin from '@homotechsual/docusaurus-plugin-faqs'
import type { PluginOptions as FAQOptions } from '@homotechsual/docusaurus-plugin-faqs'

export default {
  plugins: [
    [
      faqsPlugin,
      {
        path: 'data/faqs',
        routeBasePath: 'faqs',
      } satisfies FAQOptions,
    ],
  ],
}

For all configuration options, writing FAQ entries, direct links, and i18n support, see the docs.

Licence

Apache-2.0