From efdf394445dd16f271ad280fe4862ef1e72dab9b Mon Sep 17 00:00:00 2001 From: James Ray <16969914+jamesray1@users.noreply.github.com> Date: Fri, 25 May 2018 19:28:43 +1000 Subject: [PATCH 1/3] Add to the template warnings for contributors --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a578fb..3dd3e8d 100644 --- a/README.md +++ b/README.md @@ -97,8 +97,10 @@ Available modes are: By default, doctoc places the toc at the top of the file. You can indicate to have it placed elsewhere with the following format: ``` - + + + ``` You place this code directly in your .md file. For example: From ace0f00455b193958712b8aacc5cbd9c6bf5f7ce Mon Sep 17 00:00:00 2001 From: James Ray <16969914+jamesray1@users.noreply.github.com> Date: Fri, 25 May 2018 19:30:52 +1000 Subject: [PATCH 2/3] Update END doctoc comment --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 3dd3e8d..831b028 100644 --- a/README.md +++ b/README.md @@ -99,8 +99,7 @@ By default, doctoc places the toc at the top of the file. You can indicate to ha ``` - - + ``` You place this code directly in your .md file. For example: From 124e0959b8b5cd031133863ad83801e57efebee1 Mon Sep 17 00:00:00 2001 From: James Ray <16969914+jamesray1@users.noreply.github.com> Date: Tue, 29 May 2018 13:20:52 +1000 Subject: [PATCH 3/3] Add an example of doctoc generated after with a note on changed comments --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 831b028..8a147ed 100644 --- a/README.md +++ b/README.md @@ -97,9 +97,8 @@ Available modes are: By default, doctoc places the toc at the top of the file. You can indicate to have it placed elsewhere with the following format: ``` - - - + + ``` You place this code directly in your .md file. For example: @@ -118,7 +117,18 @@ Here we'll discuss... ``` -Running doctoc will insert the toc at that location. +Running doctoc will insert the toc at that location. Note that `doctoc --title '**Contents**'` will change the comments to be like so: +``` + + +**Contents** + +- ... +... + + +``` + ### Specifying a custom TOC title