Skip to content

Commit a825427

Browse files
committed
Fix documentation for title and book_title
1 parent ec495a7 commit a825427

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

book-example/src/format/theme/index-hbs.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ Here is a list of the properties that are exposed:
1919

2020
- ***language*** Language of the book in the form `en`, as specified in `book.toml` (if not specified, defaults to `en`). To use in <code
2121
class="language-html">\<html lang="{{ language }}"></code> for example.
22-
- ***title*** Title of the book, as specified in `book.toml`
22+
- ***title*** Title used for the current page. This is identical to `{{ book_title }} - {{ chapter_title }}` unless `book_title` is not set in which case it just defaults to the `chapter_title`.
23+
- ***book_title*** Title of the book, as specified in `book.toml`
2324
- ***chapter_title*** Title of the current chapter, as listed in `SUMMARY.md`
2425

2526
- ***path*** Relative path to the original markdown file from the source

0 commit comments

Comments
 (0)