Glossary, Acronyms, and Index capability within Org
Go to file
TEC 8ac176c068
Add creating md backend spec to docs
2023-01-18 23:49:13 +08:00
LICENSE Add a LICENSE file 2022-06-18 22:04:44 +08:00
README.org Update donation badge 2022-10-13 23:45:35 +08:00
org-glossary.el Tweak og-set-export-spec indentation 2023-01-18 23:44:31 +08:00
org-glossary.org Add creating md backend spec to docs 2023-01-18 23:49:13 +08:00
org-glossary.texi Add creating md backend spec to docs 2023-01-18 23:49:13 +08:00

README.org

Org Glossary

Functionality

There are four major pieces of functionality this package provides a generalised interface for glossary-like structures, with default support for:

  • Glossary
  • Acronyms
  • Indices
  • Text substitutions

For more details, see the documentation.

Example

Try using Org Glossary for all your glosses, acronyms, and more within your
favourite ML with a unicorn mascot. It attempts to provide powerful
functionality, in keeping with the simplicity of the Org ML we all know and
love.

* Glossary
- glosses :: Brief notations, giving the meaning of a word or wording in a text.
* Acronyms
- ML :: Markup Language
* Index
- unicorn

Installation

Straight

(use-package org-glossary
  :straight (:host github :repo "tecosaur/org-glossary"))

Doom

;; $DOOMDIR/packages.el
(package! org-glossary
  :recipe (:host github :repo "tecosaur/org-glossary"))

;; $DOOMDIR/config.el
(use-package! org-glossary
  :hook (org-mode . org-glossary-mode))