docsify-glossary: SD Development Fork

Simple Glossary for Docsify that replaces occurrences of words in text with links to the glossary definitions. Forked from TheGreenToaster/docsify-glossary as the original project was unmaintained for over 3 years, to address a couple of usability issues with the original script.

An example usage can be found here ./example, it is deployed automatically to this GitHub page.

Installation

1. Download the latest version of the javascript (from our releases page)
2. Add the script into your docsify source directory
3. Insert script into docsify.template.js document

<script src="./docsify-glossary.min.js"></script>

4. Create a _glossary.md file in the root directory
5. Populate the _glossary.md file with terms.

Plugin Usage

• Terms must be predicated with a consistent Markdown heading to get recognized by the glossary (see configuration)
• Terms are replaced with links in the order that they appear in the glossary file.
  • This is especially relevant for nested terminology ( e.g. API and API Usage)

Configuration

This version of the docsify-glossary plugin allows you to configure multiple aspects of the glossary. An example configuration is shown here:

glossify: {
    debug: false, # default
    glossaryLocation: './X_Appendix/Glossary/HOME.md', # default is '_glossary.md'
    terminologyHeading: '##', # default is '####', overwrite to fit your glossary heading depth
    replaceTitleTerms: false  # default is 'true'
}

Running the code

In order to run the code, you will need a node set-up on your local machine. We recommend using Node Version Manager to make this easier.

Building the code

1. Globally install docsify: npm i docsify-cli -g
2. From the project root directory, run: npm install
3. To build the code, run: npm run ci
4. THis will compile, test, and package the plugin

View the example website

Once the code has been built, you can launch the example website illustrating the use of the glossary. In order to do so:

1. Go to http://localhost:3000/
2. copy the latest version of the code into the example website: cp ./dist/@stijn-dejongh/docsify-glossary* ./example
3. Run docsify serve example

Changelog

An overview of all the changes made to this codebase can be found in the CHANGELOG file included in this repository.

TODO list

• [x] Bump dependency versions
• [x] add unit tests to the code to make this package more maintainable