https://github.com/tecosaur/org-glossary

Mirror of https://git.tecosaur.net/tec/org-glossary
https://github.com/tecosaur/org-glossary

emacs mirror org-mode

Last synced: 20 days ago
JSON representation

Mirror of https://git.tecosaur.net/tec/org-glossary

• Host: GitHub
• URL: https://github.com/tecosaur/org-glossary
• Owner: tecosaur
• License: gpl-3.0
• Created: 2022-06-07T10:12:11.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-01-04T14:52:22.000Z (11 months ago)
• Last Synced: 2024-04-28T07:45:13.006Z (7 months ago)
• Topics: emacs, mirror, org-mode
• Language: Emacs Lisp
• Homepage:
• Size: 218 KB
• Stars: 88
• Watchers: 7
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

README

        
#+title: Org Glossary

#+author: tecosaur

#+html: 


#+html: 

#+html: 


[[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