From 24fa615149e702901449ddc12883b9788e5f7061 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Sun, 2 May 2021 11:27:28 -0400 Subject: [PATCH] more detailed example in summary.md this shows a richer structure of numbered chapters to better illustrate that it uses nested markdown lists. --- guide/src/format/summary.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/guide/src/format/summary.md b/guide/src/format/summary.md index 7b2d5d8d..f2983277 100644 --- a/guide/src/format/summary.md +++ b/guide/src/format/summary.md @@ -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 thefirst 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.