diff options
author | Samy Pessé <samypesse@gmail.com> | 2015-01-26 10:19:10 +0100 |
---|---|---|
committer | Samy Pessé <samypesse@gmail.com> | 2015-01-26 10:19:10 +0100 |
commit | edc954f2ac0b13e13de68a686221e883747a9b7f (patch) | |
tree | 7a8dd3a28794be7cdb486059b07f13953154d6e0 | |
parent | 93bc86a0fe65943ac2ce0af28a8d81d438d17dbe (diff) | |
download | gitbook-edc954f2ac0b13e13de68a686221e883747a9b7f.zip gitbook-edc954f2ac0b13e13de68a686221e883747a9b7f.tar.gz gitbook-edc954f2ac0b13e13de68a686221e883747a9b7f.tar.bz2 |
Add chapter in readme about conrefs
-rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
@@ -42,6 +42,8 @@ $ gitbook build ./repository ./outputFolder * [Glossary](#glossary) * [Cover](#cover) * [AsciiDoc Support](#asciidoc) +* [Variables and Templating](#variables-and-templating) +* [Content References](#content-references) * [Plugins](#plugins) ## Output Formats @@ -109,6 +111,30 @@ Definition for this term With it's definition, this can contain bold text and all other kinds of inline markup ... ``` +#### Variables and Templating + +#### Content References + +You can use "content references," or conrefs, when writing books or documentation using GitBook. + +Include a file from the same book: + +``` +{% include "./test.md" %} +``` + +or from a git repository (with a specific revision): + +``` +{% include "git+https://github.com/GitbookIO/documentation.git/README.md#1.0.1" %} +``` + +Includes can be used with variables (see [Variables and Templating](#variables-and-templating)): + +``` +{% include book.ref_doc_readme %} +``` + #### 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`). |