Merge pull request #1514 from c-cube/patch-1

more detailed example in summary.md
This commit is contained in:
Eric Huss 2021-05-03 17:46:56 -07:00 committed by GitHub
commit 71ba6c9eb8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 2 deletions

View File

@ -34,11 +34,14 @@ allow for easy parsing. Let's see how you should format your `SUMMARY.md` file.
```markdown
# Title of Part
- [Title of the Chapter](relative/path/to/markdown.md)
- [Title of the first Chapter](relative/path/to/markdown.md)
- [Title of the second Chapter](relative/path/to/markdown2.md)
- [Title of a sub Chapter](relative/path/to/markdown3.md)
# Title of Another Part
- [More Chapters](relative/path/to/markdown2.md)
- [More Chapters](relative/path/to/markdown4.md)
```
You can either use `-` or `*` to indicate a numbered chapter.