mdBook/book-example/src/format/config.md

24 lines
778 B
Markdown
Raw Normal View History

# Configuration
2015-08-06 21:24:34 +08:00
You can configure the parameters for your book in the ***book.json*** file.
2015-08-06 21:24:34 +08:00
Here is an example of what a ***book.json*** file might look like:
```json
{
"title": "Example book",
"author": "Name",
"description": "The example book covers examples.",
2015-08-06 21:24:34 +08:00
"dest": "output/my-book"
}
```
#### Supported variables
- **title:** title 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
2015-08-06 21:24:34 +08:00
***note:*** *the supported configurable parameters are scarce at the moment, but more will be added in the future*