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

Merge pull request #2303 from infogulch/patch-1 

summary.md: clarify that part titles must be h1 headers
This commit is contained in:
Eric Huss 2024-02-01 23:45:51 +00:00 committed by GitHub
parent 220cb4f0c8 63000bc122
commit 53eccf7047
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
guide/src/format/summary.md
View File

@ -29,11 +29,12 @@ to be ignored at best, or may cause an error when attempting to build the book.
- [First Chapter](relative/path/to/markdown2.md) - [First Chapter](relative/path/to/markdown2.md)
``` ```
1. ***Part Title*** - Headers can be used as a title for the following numbered 1. ***Part Title*** -
chapters. This can be used to logically separate different sections Level 1 headers can be used as a title for the following numbered chapters.
of the book. The title is rendered as unclickable text. This can be used to logically separate different sections of the book.
Titles are optional, and the numbered chapters can be broken into as many The title is rendered as unclickable text.
parts as desired. Titles are optional, and the numbered chapters can be broken into as many parts as desired.
Part titles must be h1 headers (one `#`), other heading levels are ignored.
```markdown ```markdown
# My Part Title # My Part Title