docusaurus-plugin-glossary 2.0.0 → 2.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,8 +1,13 @@
1
1
  # docusaurus-plugin-glossary
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/docusaurus-plugin-glossary.svg)](https://www.npmjs.com/package/docusaurus-plugin-glossary)
4
+ [![ci](https://github.com/mcclowes/docusaurus-plugin-glossary/actions/workflows/ci.yml/badge.svg)](https://github.com/mcclowes/docusaurus-plugin-glossary/actions/workflows/ci.yml)
5
+
6
+ ![docusaurus-plugin-glossary banner](banner.png)
7
+
3
8
  A comprehensive Docusaurus plugin that provides glossary functionality with an auto-generated glossary page, searchable terms, and inline term tooltips.
4
9
 
5
- > Compatibility: Fully compatible with Docusaurus v3 (MDX v3). If you were on a v2-era fork, please upgrade to the latest 1.x release of this plugin.
10
+ > Compatibility: Fully compatible with Docusaurus v3 (MDX v3). If you were on a v2-era fork, please upgrade to the latest 2.x release of this plugin.
6
11
 
7
12
  ## Features
8
13
 
@@ -491,7 +496,7 @@ principles to provide a simple and consistent interface.
491
496
 
492
497
  ## Development
493
498
 
494
- This project is written in TypeScript and compiles to JavaScript. The source files are in `src/` and the compiled output goes to `lib/`.
499
+ This project is written in TypeScript and compiles to JavaScript. The source files are in `src/` and the compiled output goes to `dist/`.
495
500
 
496
501
  ### File Structure
497
502
 
@@ -512,7 +517,7 @@ docusaurus-plugin-glossary/
512
517
  │ ├── index.js # Term component
513
518
  │ ├── styles.module.css
514
519
  │ └── index.test.js
515
- ├── lib/ # Compiled output (generated by build)
520
+ ├── dist/ # Compiled output (generated by build)
516
521
  │ ├── index.js # Main plugin file (compiled from src/index.ts)
517
522
  │ ├── client/ # Copied from src/client/
518
523
  │ ├── components/ # Copied from src/components/
@@ -538,8 +543,8 @@ npm run build
538
543
  ```
539
544
 
540
545
  This will:
541
- 1. Compile TypeScript (`src/index.ts`) to JavaScript (`lib/index.js`)
542
- 2. Copy JavaScript, CSS, and test files from `src/` to `lib/`
546
+ 1. Compile TypeScript (`src/index.ts`) to JavaScript (`dist/index.js`)
547
+ 2. Copy JavaScript, CSS, and test files from `src/` to `dist/`
543
548
 
544
549
  For development, use:
545
550
 
@@ -623,5 +628,5 @@ Built for Docusaurus v3.x
623
628
 
624
629
  - **Language**: TypeScript (main plugin) + JavaScript (components)
625
630
  - **Build System**: TypeScript compiler + custom build scripts
626
- - **Package Entry Point**: `lib/index.js` (compiled from `src/index.ts`)
631
+ - **Package Entry Point**: `dist/index.js` (compiled from `src/index.ts`)
627
632
  - **Exports**: Main plugin, remark plugin via package.json exports field
package/package.json CHANGED
@@ -1,23 +1,23 @@
1
1
  {
2
2
  "name": "docusaurus-plugin-glossary",
3
- "version": "2.0.0",
3
+ "version": "2.0.2",
4
4
  "description": "A Docusaurus plugin for creating and managing glossary terms with auto-generated pages and inline tooltips",
5
5
  "type": "module",
6
- "main": "lib/index.js",
6
+ "main": "dist/index.js",
7
7
  "exports": {
8
8
  ".": {
9
- "import": "./lib/index.js",
10
- "require": "./lib/index.js",
11
- "default": "./lib/index.js"
9
+ "import": "./dist/index.js",
10
+ "require": "./dist/index.js",
11
+ "default": "./dist/index.js"
12
12
  },
13
13
  "./remark/glossary-terms": {
14
- "import": "./lib/remark/glossary-terms.js",
15
- "require": "./lib/remark/glossary-terms.js",
16
- "default": "./lib/remark/glossary-terms.js"
14
+ "import": "./dist/remark/glossary-terms.js",
15
+ "require": "./dist/remark/glossary-terms.js",
16
+ "default": "./dist/remark/glossary-terms.js"
17
17
  }
18
18
  },
19
19
  "files": [
20
- "lib/",
20
+ "dist/",
21
21
  "README.md",
22
22
  "LICENSE"
23
23
  ],
@@ -71,6 +71,7 @@
71
71
  "devDependencies": {
72
72
  "@babel/preset-env": "^7.28.5",
73
73
  "@babel/preset-react": "^7.28.5",
74
+ "@babel/preset-typescript": "^7.28.5",
74
75
  "@docusaurus/tsconfig": "^3.9.2",
75
76
  "@docusaurus/types": "^3.9.2",
76
77
  "@testing-library/jest-dom": "^6.9.1",
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes