Skip to content

Commit 53eccf7

Browse files
authored
Merge pull request rust-lang#2303 from infogulch/patch-1
summary.md: clarify that part titles must be h1 headers
2 parents 220cb4f + 63000bc commit 53eccf7

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

guide/src/format/summary.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ to be ignored at best, or may cause an error when attempting to build the book.
2929
- [First Chapter](relative/path/to/markdown2.md)
3030
```
3131

32-
1. ***Part Title*** - Headers can be used as a title for the following numbered
33-
chapters. This can be used to logically separate different sections
34-
of the book. The title is rendered as unclickable text.
35-
Titles are optional, and the numbered chapters can be broken into as many
36-
parts as desired.
32+
1. ***Part Title*** -
33+
Level 1 headers can be used as a title for the following numbered chapters.
34+
This can be used to logically separate different sections of the book.
35+
The title is rendered as unclickable text.
36+
Titles are optional, and the numbered chapters can be broken into as many parts as desired.
37+
Part titles must be h1 headers (one `#`), other heading levels are ignored.
3738
```markdown
3839
# My Part Title
3940

0 commit comments

Comments
 (0)