Skip to content

Commit

Permalink
Document configuration options
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathan Parsons committed Aug 8, 2019
1 parent 38eb003 commit f2f64b1
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,20 @@ You can add abbreviation tags `<abbrev>` to all abbreviations on your site by en
**Note:** Currently, abbreviations only work within the page content, and so tags aren't applied to parts of the page that are generated by other means.


## Configuration

The Glossary plugin has the following configuration options:

- `enabled` (bool): Determines whether the plugin is enabled.
- `builtin_css` (bool): Whether to load the built-in CSS on the glossary page.
- `show_search` (bool): Whether to show search on the glossary page (requires Simple Search).
- `fa_search_icon` (text): Font Awesome icon to use in the search button (eg. `fas fa-search`). Setting this to an empty string displays the icon from the SimpleSearch plugin.
- `fa_reset_icon`(text): Font Awesome icon to use in the search reset button (eg. `fas fa-times`).
- `item_template` (text): Template to use for formatting glossary items.
- `abbreviations` (bool): Whether to enable site-wide abbreviations (required Markdown Extra).
- `definitions` (list): List of arrays with the keys `term`, `abbrev`, and `definition`.


## Credits

The implementation of the abbreviation insertion is taken from the [acronyms](https://github.com/asmeikal/grav-plugin-acronyms) plugin originally developed by [Michele Laurenti](https://github.com/asmeikal). If you just want the acronym component of this plugin, you could use the original [acronyms](https://github.com/asmeikal/grav-plugin-acronyms) plugin, although it is not currently in the GPM.
Expand Down
2 changes: 1 addition & 1 deletion blueprints.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ form:
show_search:
type: toggle
label: Search on glossary page
info: Requires Simple Search
help: Requires Simple Search
highlight: 1
default: 1
options:
Expand Down

0 comments on commit f2f64b1

Please sign in to comment.