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

Add informations about the logo to the guide

This commit is contained in:
Björn Guth 2021-06-24 14:46:23 +02:00
parent b391d933ef
commit bf5b900a80
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
guide/src/format/configuration/general.md
View File

@ -46,8 +46,11 @@ This is general information about your book.
`src` directly under the root folder. But this is configurable with the `src` `src` directly under the root folder. But this is configurable with the `src`
key in the configuration file. key in the configuration file.
- **language:** The main language of the book, which is used as a language attribute `<html lang="en">` for example. - **language:** The main language of the book, which is used as a language attribute `<html lang="en">` for example.
- **logo:** Path to a logo to shown at the top of the navigation bar. If this
is given as a relative path, it's base directory is the source directory.
**book.toml** **book.toml**
```toml ```toml
[book] [book]
title = "Example book" title = "Example book"
@ -55,6 +58,7 @@ authors = ["John Doe", "Jane Doe"]
description = "The example book covers examples." description = "The example book covers examples."
src = "my-src" # the source files will be found in `root/my-src` instead of `root/src` src = "my-src" # the source files will be found in `root/my-src` instead of `root/src`
language = "en" language = "en"
logo = "static/logo.png"
``` ```
### Rust options ### Rust options