Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.87 KB

README.md

File metadata and controls

42 lines (26 loc) · 1.87 KB

Acronym Plugin

The Acronym Plugin is for Grav CMS. Its intended usage is to define a set of Markdown Extra abbreviations that will appear in every page of the site.

Installation

To install this plugin, just download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to acronym.

You should now have all the plugin files under

/your/site/grav/user/plugins/acronym

NOTE: This plugin is a modular component for Grav which requires Grav to operate.

Configuration

Before configuring this plugin, you should copy the user/plugins/acronym/acronym.yaml to user/config/plugins/acronym.yaml and only edit that copy.

To configure the plugin, edit the acronym.yaml file and specify the desired abbreviations under acronyms. Abbreviations are specified as key-value pairs, with the key being the abbreviation (or acronym), and the value being the full name.

enabled: true
acronyms:
  HTML: Hyper Text Markup Language
  W3C: World Wide Web Consortium