Skip to content

Commit 3c10a85

Browse files
committed
Add documentation and example for description config
1 parent 330b1ad commit 3c10a85

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

book-example/book.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
22
"title": "mdBook Documentation",
3+
"description": "Create book from markdown files. Like Gitbook but implemented in Rust",
34
"author": "Mathieu David"
45
}

book-example/src/format/config.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Here is an example of what a ***book.json*** file might look like:
88
{
99
"title": "Example book",
1010
"author": "Name",
11+
"description": "The example book covers examples.",
1112
"dest": "output/my-book"
1213
}
1314
```
@@ -16,6 +17,7 @@ Here is an example of what a ***book.json*** file might look like:
1617

1718
- **title:** title of the book
1819
- **author:** author of the book
20+
- **description:** description, which is added as meta in the html head of each page.
1921
- **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
2022

2123
***note:*** *the supported configurable parameters are scarce at the moment, but more will be added in the future*

0 commit comments

Comments
 (0)