diff options
| author | Samy Pesse <samypesse@gmail.com> | 2016-02-24 22:51:32 +0100 |
|---|---|---|
| committer | Samy Pesse <samypesse@gmail.com> | 2016-02-24 22:51:32 +0100 |
| commit | addf6ade9ae594f6c5ab8bf112f5237459550c53 (patch) | |
| tree | d307a7357efa112cfbba15ef5c4d666cb27d2a9d /docs | |
| parent | d7d0429169ea097dcd51d9622036390433410944 (diff) | |
| download | gitbook-addf6ade9ae594f6c5ab8bf112f5237459550c53.zip gitbook-addf6ade9ae594f6c5ab8bf112f5237459550c53.tar.gz gitbook-addf6ade9ae594f6c5ab8bf112f5237459550c53.tar.bz2 | |
Add doc for glossary
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/SUMMARY.md | 4 | ||||
| -rw-r--r-- | docs/lexicon.md | 13 | ||||
| -rw-r--r-- | docs/pages.md | 4 | ||||
| -rw-r--r-- | docs/structure.md | 2 |
4 files changed, 18 insertions, 5 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index dd48c67..c653e63 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -2,14 +2,14 @@ ### Getting Started -* [About this document](README.md) +* [About this documentation](README.md) * [Installation and Setup](setup.md) ### Your Content * [Directory structure](structure.md) * [Pages and Summary](pages.md) -* [Glossary](glossary.md) +* [Glossary](lexicon.md) * [Multi-Lingual](langs.md) * [Configuration](config.md) diff --git a/docs/lexicon.md b/docs/lexicon.md new file mode 100644 index 0000000..5d356b4 --- /dev/null +++ b/docs/lexicon.md @@ -0,0 +1,13 @@ +# Glossary + +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 : + +```markdown +# Term +Definition for this term + +# Another term +With it's definition, this can contain bold text and all other kinds of inline markup ... +```
\ No newline at end of file diff --git a/docs/pages.md b/docs/pages.md index e72ffad..6528c93 100644 --- a/docs/pages.md +++ b/docs/pages.md @@ -8,7 +8,7 @@ Subchapters are defined simply by adding a nested list to a parent chapter. ### Simple example -``` +```markdown # Summary * [Part I](part1/README.md) @@ -21,7 +21,7 @@ Subchapters are defined simply by adding a nested list to a parent chapter. ### Example with subchapters split into parts -``` +```markdown # Summary ### Part 1 diff --git a/docs/structure.md b/docs/structure.md index 18c4abb..e77c271 100644 --- a/docs/structure.md +++ b/docs/structure.md @@ -33,7 +33,7 @@ A static file is a file that is not listed in the `SUMMARY.md`. All static files 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`: -``` +```markdown # This is a comment # Ignore the file test.md |