summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2014-08-19 16:16:59 -0700
committerSamy Pessé <samypesse@gmail.com>2014-08-19 16:16:59 -0700
commit21704c4ac2ca91d51085428415e045d18ab4209f (patch)
tree07c96e2a12c14be47198507e79932d61f2e23fe4
parent71aff100921f7fcf94c9d75e0bd17c4fcb4669b6 (diff)
downloadgitbook-21704c4ac2ca91d51085428415e045d18ab4209f.zip
gitbook-21704c4ac2ca91d51085428415e045d18ab4209f.tar.gz
gitbook-21704c4ac2ca91d51085428415e045d18ab4209f.tar.bz2
Add documentation for glossary format
-rw-r--r--README.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/README.md b/README.md
index 325e89c..7df0ad2 100644
--- a/README.md
+++ b/README.md
@@ -148,7 +148,7 @@ The `SUMMARY.md` defines your book's structure. It should contain a list of chap
Example:
-```
+```markdown
# Summary
This is the summary of my book.
@@ -166,7 +166,7 @@ Files that are not included in `SUMMARY.md` will not be processed by `gitbook`.
GitBook supports building books written in multiple languages. Each language should be a sub-directory following the normal GitBook format, and a file named `LANGS.md` should be present at the root of the repository with the following format:
-```
+```markdown
* [English](en/)
* [French](fr/)
* [Español](es/)
@@ -174,6 +174,21 @@ GitBook supports building books written in multiple languages. Each language sho
You can see a complete example with the [Learn Git](https://github.com/GitbookIO/git) book.
+#### GLOSSARY.md
+
+Allows you to specify terms and their respective definitions to be displayed in the glossary. Based on those terms, `gitbook` will automatically build an index and highlight those terms in pages.
+
+The `GLOSSARY.md` format is very simple :
+
+```markdown
+# term
+Definition for this term
+
+# Another term
+With it's definition, this can contain bold text and all other kinds of inline markup ...
+
+```
+
#### Ignoring files & folders
GitBook will read the `.gitignore`, `.bookignore` and `.ignore` files to get a list of files and folders to skip. (The format inside those files follows the same convention as `.gitignore`).