This project makes it easy to create a glossary as a single HTML page that can be hosted anywhere.
- Includes integrated (single-user) editor UI that saves changes back to the HTML file — requires Node.js.
- Represents a glossary as a standard
dlelement for accessibility and portability. - Supports different screen sizes using responsive design and includes dark mode support.
- Write in a Markdown-based syntax.
- Supports math typesetting using KaTeX.
Download glossary.html from the latest release and open it in a browser.
The HTML file points to glstatic.net for static assets hosted using Cloudflare:
https://glstatic.net/glossary-page-template@4/glossary.min.js
https://glstatic.net/glossary-page-template@4/glossary.min.css
The above assets are cached for 24 hours and get updated with any releases with a major version number of 4. Alternatively you can change the URL to point to e.g. @4.1 which gets all patch releases with version numbers of the form 4.1.x. You can also use a specific version such as 4.1.2 — these are cached forever.
The approach above is the easiest one, but the safest option would be to either host the static assets yourself and/or use Subresource Integrity (SRI) by specifying hashes for the static assets.
To host the static assets yourself, you can get them from the .tar.gz package in a release, which also contains a glossary template file that uses them.
To use SRI, change the two lines at the end of the <head> element so they
- point to a specific version of the JS and CSS files,
- have a
crossoriginattribute, and - have an
integrity="hash-here"attribute.
You can get the hash-here values from the release notes.
- The integrated editor UI is meant to be run and used by a single local user only. It is not designed to be exposed to untrusted users.
- In its current state this project is not very suitable for glossaries of more than (say) 500 items. At the moment everything is stored in a single HTML file, and the DOM size and browser memory usage grows as the number of items does. (I'm planning to address this.)
Distributed under the MIT License. See LICENSE for more information.
This project is mainly written in Elm and relies on elm-markdown for parsing and rendering Markdown. The UI is based on components from Tailwind UI. Most icons are from either Heroicons or Lucide.
Thanks to everyone who contributed suggestions for improvements.