Skip to main content

docusaurus-plugin-glossary

Three things in one package:

  1. An auto-generated glossary page at /glossary (or wherever you configure it) — alphabetized, searchable, with letter-based navigation
  2. A <GlossaryTerm> theme component you can use inline in MDXMDX A Markdown-based format that lets you write JSX inside your markdown, used by Docusaurus v3 for docs and pages.
  3. A remarkremark A markdown processor. Remark plugins transform the markdown AST before it becomes HTML/JSX. plugin that automatically detects glossary terms in your markdown and wraps them with <GlossaryTerm> — no manual imports needed

You define terms once in a JSON file; the plugin handles everything else.

Why use it​

  • You have a growing vocabulary of technical terms and you want one canonical place for them
  • You want tooltips on hover for unfamiliar terms, without rewriting all your markdown
  • You want a standalone /glossary page users can browse

Live demo​

Visit the /glossary page of this site — it's generated from glossary/glossary.json. Terms in these docs (like API, REST) are auto-linked to it.

Real-world example​

Full runnable example site at examples/docusaurus-v3/.

Compatibility​

  • Docusaurus ^3.0.0 with MDXMDX A Markdown-based format that lets you write JSX inside your markdown, used by Docusaurus v3 for docs and pages. v3
  • React ^18

Exports​

  • Default — the plugin function
  • /preset — a wrapped preset-classic that auto-configures the remarkremark A markdown processor. Remark plugins transform the markdown AST before it becomes HTML/JSX. plugin
  • getRemarkPlugin() — helper for manual preset setups
  • remarkPlugin — raw remarkremark A markdown processor. Remark plugins transform the markdown AST before it becomes HTML/JSX. plugin if you want full control