Awesome
docsify-glossary
Simple Glossary for Docsify that replaces occurrences of the terms with links to the glossary.
Install
- Insert script into docsify document
<script src="//unpkg.com/docsify-glossary/dist/docsify-glossary.min.js"></script>
- Create a
_glossary.md
file in the root directory - Populate the
_glossary.md
file with terms.
Usage
- Terms must be predicated with
#####
to get recognized by the glossary - Terms in the documentation must be surrounded by space to get replaced by the regular expression
- Terms are replaced with links in the order that they appear in the glossary file.
Example
- Run
npm run-script build
- Run
docsify serve example
- Go to http://localhost:3000/