Generate TOC (table of contents) of headlines from parsed markdown file.
- 1. Features
- 2. Installation
- 3. Usage
- 4. Configuration
- 5. Contributors
- 6. What's New?
- 7. Question
- 8. License
- 9. Links
- Insert header number sections.
- Auto active plugin on markdown
- Insert anchor for header
<a id="markdown-header" name="header"></a>
- Linking via anchor tags
# A 1
โ#a-1
- Depth control[1-6] with
depthFrom:1
anddepthTo:6
- Enable or disable links with
withLinks:true
- Refresh list on save with
updateOnSave:true
- Use ordered list (1. ..., 2. ...) with
orderedList:true
- Anchor support for (github.com|nodejs.org|bitbucket.org|ghost.org|gitlab.com).
ext install markdown-toc
Tips:Section of header is begin with depthFrom
attributes | values | defaults |
---|---|---|
depthFrom | uint(1-6) | 1 |
depthTo | uint(1-6) | 6 |
insertAnchor | bool | false |
withLinks | bool | true |
orderedList | bool | false |
updateOnSave | bool | true |
anchorMode | github.com/bitbucket.org/ghost.org/gitlab.com | github.com |
To change the default configuration settings for the Markdown-TOC extension, edit the user or workspace settings as described here. The available settings are as follows:
attributes | values | defaults |
---|---|---|
markdown-toc.depthFrom | number(1-6) | 1 |
markdown-toc.depthTo | number(1-6) | 6 |
markdown-toc.insertAnchor | bool | false |
markdown-toc.withLinks | bool | true |
markdown-toc.orderedList | bool | false |
markdown-toc.updateOnSave | bool | true |
markdown-toc.anchorMode | enum | github.com |
If you want to use a unique setting for a file, you can add attributes to <!-- TOC -->
, just like:
<!-- TOC depthFrom:2 orderedList:true -->
<!-- /TOC -->
- sine sawtooth (Add: Header number section)
- chriscamicas (Update: Anchor generation)
- kevindaub (Add : Use workspace settings for tabs and eOL)
- rovest (Feature: Insert anchor)
- zhiguang Wang(Fix: Recognised code to header list)
- jgroom33 (Fix: Codeblock error)
- satokaz (Fix: Codeblock error)
If you have any question, you can contact with me:
- Mail : [email protected]
- Twitter : @AlanWalk93
- Github : AlanWalk
The package is Open Source Software released under the License. It's developed by AlanWalk.