From 24fa615149e702901449ddc12883b9788e5f7061 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Sun, 2 May 2021 11:27:28 -0400 Subject: [PATCH 1/4] 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. From 9f930706bb55c0f1cc37de1b5a6b5c8faefb7b39 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Sun, 2 May 2021 21:21:41 -0400 Subject: [PATCH 2/4] Update guide/src/format/summary.md Co-authored-by: josh rotenberg --- guide/src/format/summary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guide/src/format/summary.md b/guide/src/format/summary.md index f2983277..166e16b1 100644 --- a/guide/src/format/summary.md +++ b/guide/src/format/summary.md @@ -34,7 +34,7 @@ allow for easy parsing. Let's see how you should format your `SUMMARY.md` file. ```markdown # Title of Part - - [Title of thefirst 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) From ffe88d7e29140cd10dfbf2cf1032dd302a6ac627 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Mon, 3 May 2021 20:16:05 -0400 Subject: [PATCH 3/4] Update guide/src/format/summary.md Co-authored-by: Eric Huss --- guide/src/format/summary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guide/src/format/summary.md b/guide/src/format/summary.md index 166e16b1..f98b05fd 100644 --- a/guide/src/format/summary.md +++ b/guide/src/format/summary.md @@ -36,7 +36,7 @@ allow for easy parsing. Let's see how you should format your `SUMMARY.md` file. - [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 a sub Chapter](relative/path/to/markdown3.md) # Title of Another Part From 9d4ee689dbae18103900fcff2dac9491e7ef2c57 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Mon, 3 May 2021 20:16:11 -0400 Subject: [PATCH 4/4] Update guide/src/format/summary.md Co-authored-by: Eric Huss --- guide/src/format/summary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guide/src/format/summary.md b/guide/src/format/summary.md index f98b05fd..d7d57d15 100644 --- a/guide/src/format/summary.md +++ b/guide/src/format/summary.md @@ -34,7 +34,7 @@ allow for easy parsing. Let's see how you should format your `SUMMARY.md` file. ```markdown # Title of Part - - [Title of the first 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)