actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentation and example for description config

This commit is contained in:
Jesse Stricker 2016-02-25 15:01:16 +01:00
parent 330b1ad55d
commit 3c10a85735
2 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
book-example/book.json
View File

@ -1,4 +1,5 @@
{ {
"title": "mdBook Documentation", "title": "mdBook Documentation",
"description": "Create book from markdown files. Like Gitbook but implemented in Rust",
"author": "Mathieu David" "author": "Mathieu David"
} }

2
book-example/src/format/config.md
View File

@ -8,6 +8,7 @@ Here is an example of what a ***book.json*** file might look like:
{ {
"title": "Example book", "title": "Example book",
"author": "Name", "author": "Name",
"description": "The example book covers examples.",
"dest": "output/my-book" "dest": "output/my-book"
} }
``` ```
@ -16,6 +17,7 @@ Here is an example of what a ***book.json*** file might look like:
- **title:** title of the book - **title:** title of the book
- **author:** author of the book - **author:** author of the book
- **description:** description, which is added as meta in the html head of each page.
- **dest:** path to the directory where you want your book to be rendered. If a relative path is given it will be relative to the parent directory of the source directory - **dest:** path to the directory where you want your book to be rendered. If a relative path is given it will be relative to the parent directory of the source directory
***note:*** *the supported configurable parameters are scarce at the moment, but more will be added in the future* ***note:*** *the supported configurable parameters are scarce at the moment, but more will be added in the future*