summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/lexicon.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/lexicon.md b/docs/lexicon.md
index 5740139..3250d32 100644
--- a/docs/lexicon.md
+++ b/docs/lexicon.md
@@ -2,13 +2,13 @@
Allows you to specify terms and their respective definitions to be displayed as annotations. Based on those terms, GitBook will automatically build an index and highlight those terms in pages.
-The `GLOSSARY.md` format is very simple :
+The `GLOSSARY.md` format is a list of `h2` headings, along with a description paragraph:
```markdown
-# Term
+## Term
Definition for this term
-# Another term
+## Another term
With it's definition, this can contain bold text
and all other kinds of inline markup ...
```