Glossary

日本語

Builds a glossary page from published notes marked with glossary: true. Use ordinary links or Obsidian WikiLinks to reference the individual term pages.

Installation

pnpm add @riebeckite/plugin-glossary

Usage

import { glossary } from "@riebeckite/plugin-glossary";
 
export default {
  plugins: [glossary()],
};

---
title: Static site generation
glossary: true
term: SSG
definition: Generates HTML before deployment.
---

The plugin creates /glossary, alphabetically ordered by term. When term is absent, the note title is used. definition is optional. Only discoverable notes appear. The plugin includes a responsive glossary stylesheet that uses the active theme's color and typography tokens.

Live example

Open the Glossary

Options

Option	Type	Default	Description
`basePath`	`string`	`"/glossary"`	Generated page path. An empty string disables it.
`key`	`string`	`"glossary"`	Boolean frontmatter key used to select notes.
`termKey`	`string`	`"term"`	Frontmatter key for the displayed term.
`definitionKey`	`string`	`"definition"`	Optional short definition key.
`title`	`string`	`"Glossary"`	Page heading and title.
`className`	`string`	`"rb-glossary"`	Root CSS class.