Minimal Docusaurus 3 sites demonstrating proposed features for docusaurus-plugin-glossary.
Each folder is a self-contained Docusaurus project. Run npm install && npm start
inside any of them to see the feature in action.
| Folder | Issue | Feature |
|---|---|---|
example-129-link-only-first-occurrence |
#129 | Link only the first occurrence of a term per page |
example-162-short-definition |
#162 | shortDefinition field for concise tooltip text |
example-163-references |
#163 | references (source links) and definitionType (badge) fields |
example-164-acronym |
#164 | acronym field — full-name canonical entry with short-form expansion |
| Issue | Status | Notes |
|---|---|---|
| #129 | 🔀 Merged, not released | Merged on master but not in v3.4.0 (latest npm); demo uses getRemarkPlugin directly, no local patch |
| #162 | 🔄 Open | Requires local remark plugin + swizzled GlossaryTerm |
| #163 | 🔄 Partial | references already upstream; definitionType requires local GlossaryPage patch |
| #164 | 🔄 Open | Requires local remark plugin + swizzled GlossaryTerm + extended GlossaryPage |
cd example-162-short-definition # or any other folder
npm install
npm startOpen http://localhost:3000.
| Path | Purpose |
|---|---|
src/remark/glossary-sdc.cjs |
Extended remark plugin — passes extra props to GlossaryTerm |
src/theme/GlossaryTerm/ |
Swizzled component — tooltip with shortDefinition / acronym support |
src/components/GlossaryPage.tsx |
Extended glossary page — renders definitionType badge |
src/plugins/glossary-page-override.cjs |
Docusaurus plugin — swaps upstream GlossaryPage.js via webpack NormalModuleReplacementPlugin |
These local files are temporary scaffolding. Once a feature is merged upstream and released on npm, the corresponding local files can be removed.