Skip to content

Commit

Permalink
Merge pull request #2303 from infogulch/patch-1
Browse files Browse the repository at this point in the history
summary.md: clarify that part titles must be h1 headers
  • Loading branch information
ehuss authored Feb 1, 2024
2 parents 220cb4f + 63000bc commit 53eccf7
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions guide/src/format/summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```

1. ***Part Title*** - Headers can be used as a title for the following numbered
chapters. This can be used to logically separate different sections
of the book. The title is rendered as unclickable text.
Titles are optional, and the numbered chapters can be broken into as many
parts as desired.
1. ***Part Title*** -
Level 1 headers can be used as a title for the following numbered chapters.
This can be used to logically separate different sections of the book.
The title is rendered as unclickable text.
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
# My Part Title

Expand Down

0 comments on commit 53eccf7

Please sign in to comment.