org-glossary/README.org

#+title: Org Glossary
#+author: tecosaur

#+html: <p><img src="https://img.shields.io/badge/Emacs-27.1+-blueviolet.svg?style=flat-square&logo=GNU%20Emacs&logoColor=white">
#+html: <img src="https://img.shields.io/badge/stage-%CE%B2,%20refinement-orange?style=flat-square">
#+html: <a href="https://liberapay.com/tec"><img src="https://shields.io/badge/support%20my%20efforts-f6c915?logo=Liberapay&style=flat-square&logoColor=black"></a></p>

[[https://user-images.githubusercontent.com/20903656/221879246-69037b9e-15f4-40e4-b925-a3c271787a99.png]]

* 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 [[file:org-glossary.org][documentation]].

* Example

#+begin_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
#+end_example

* Installation
** Straight
#+begin_src elisp
(use-package org-glossary
  :straight (:host github :repo "tecosaur/org-glossary"))
#+end_src

** Doom
#+begin_src elisp
;; $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))
#+end_src