Markdown to create pages and table of contents?
I started to use markdown to take notes.
I use marked to view my markdown notes and its beautiful.
But as my notes get longer I find it difficult to find what I want.
I know markdown can create tables, but is it able to create table of contents, that jumps to sections, or define page sections in markdown?
Alternatively, are there markdown readers/editors that could do such things. Search would be good feature to have too.
In short, I want to make it my awesome note taking tool and functions much like writing a book etc.
You can give this a try.
# Table of Contents
1. [Example](#example)
2. [Example2](#example2)
3. [Third Example](#third-example)
4. [Fourth Example](#fourth-examplehttpwwwfourthexamplecom)
## Example
## Example2
## Third Example
## [Fourth Example](http://www.fourthexample.com)
Here's a useful method. Should produce clickable references in any MarkDown editor.
# Table of contents
1. [Introduction](#introduction)
2. [Some paragraph](#paragraph1)
1. [Sub paragraph](#subparagraph1)
3. [Another paragraph](#paragraph2)
## This is the introduction <a name="introduction"></a>
Some introduction text, formatted in heading 2 style
## Some paragraph <a name="paragraph1"></a>
The first paragraph text
### Sub paragraph <a name="subparagraph1"></a>
This is a sub paragraph, formatted in heading 3 style
## Another paragraph <a name="paragraph2"></a>
The second paragraph text
Produces:
Table of contents
- Introduction
-
Some paragraph
- Sub paragraph
- Another paragraph
This is the introduction
Some introduction text, formatted in heading 2 style
Some paragraph
The first paragraph text
Sub paragraph
This is a sub paragraph, formatted in heading 3 style
Another paragraph
The second paragraph text
For the Visual Studio Code users the best option to use today (2020) is the Markdown All in One plugin.
To install it, launch the VS Code Quick Open (Control/⌘+P), paste the following command, and press enter.
ext install yzhang.markdown-all-in-one
And to generate the TOC, open the command palette (Control/⌘+Shift+P) and select the Select Markdown: Create Table of Contents
option.
Another option is the Markdown TOC plugin.
To install it, launch the VS Code Quick Open (Control/⌘+P), paste the following command, and press enter.
ext install markdown-toc
And to generate the TOC, open the command palette (Control/⌘+Shift+P) and select the Markdown TOC:Insert/Update
option or use Control/⌘+MT.
MultiMarkdown Composer does seem to generate a table of contents to assist while editing.
There might also be the one or the other library, who can generate TOCs: see Python Markdown TOC Extension.
There are 2 way to create your TOC (summary) in your markdown document.
1. Manually
# My Table of content
- [Section 1](#id-section1)
- [Section 2](#id-section2)
<div id='id-section1'/>
## Section 1
<div id='id-section2'/>
## Section 2
2. Programmatically
You can use for example a script that generate summary for you, take a look to my project on github - summarizeMD -
I've tried also other script/npm module (for example doctoc) but no one reproduce a TOC with working anchors.