All Projects → AlanWalk → Markdown Toc

AlanWalk / Markdown Toc

Licence: mit
MarkdownTOC(Table Of Contents) Plugin for Visual Studio Code.

Programming Languages

typescript
32286 projects

Projects that are alternatives of or similar to Markdown Toc

Vscode Js Annotations
Javascript / Typescript Parameter Annotations for Visual Studio Code
Stars: ✭ 110 (-15.38%)
Mutual labels:  vscode, vscode-extension
Vscode Scss
🔌 IntelliSense for Variables, Mixins and Functions in all Sass (SCSS syntax only) files.
Stars: ✭ 128 (-1.54%)
Mutual labels:  vscode, vscode-extension
Vscode
Unibeautify for VSCode
Stars: ✭ 110 (-15.38%)
Mutual labels:  vscode, vscode-extension
Vscode Solidity Auditor
Solidity language support and visual security auditor for Visual Studio Code
Stars: ✭ 108 (-16.92%)
Mutual labels:  vscode, vscode-extension
Doxdocgen
Generate doxygen documentation from source code in VS Code
Stars: ✭ 127 (-2.31%)
Mutual labels:  vscode, vscode-extension
Flowmaker
flowmaker: JS to SVG flowchart generation extension for Vscode in realtime written in typescript and also download the SVG through local node server. Extension:
Stars: ✭ 108 (-16.92%)
Mutual labels:  vscode, vscode-extension
Vscode Apielements
VSCode extensions for API Elements (aka: API Blueprint and Swagger)
Stars: ✭ 117 (-10%)
Mutual labels:  vscode, vscode-extension
Laserwave
A retro outrun / cyberpunk inspired VS Code theme
Stars: ✭ 102 (-21.54%)
Mutual labels:  vscode, vscode-extension
Vscode Postgres
PostgreSQL extension for vscode providing explorer, highlighting, diagnostics, and intellisense
Stars: ✭ 117 (-10%)
Mutual labels:  vscode, vscode-extension
Vscode Azure Blockchain Ethereum
Blockchain extension for VS Code
Stars: ✭ 111 (-14.62%)
Mutual labels:  vscode, vscode-extension
Vscode Winteriscoming
Dark theme with fun and bright foreground colors
Stars: ✭ 105 (-19.23%)
Mutual labels:  vscode, vscode-extension
Vscode Elastic
Elasticsearch for VSCode
Stars: ✭ 130 (+0%)
Mutual labels:  vscode, vscode-extension
Vscode Mdx Preview
MDX Preview for Visual Studio Code
Stars: ✭ 103 (-20.77%)
Mutual labels:  vscode, vscode-extension
Vscode Ptt
在 VSCode 瀏覽 PTT!
Stars: ✭ 110 (-15.38%)
Mutual labels:  vscode, vscode-extension
Vscode Yuml
yUML extension for Visual Studio Code
Stars: ✭ 102 (-21.54%)
Mutual labels:  vscode, vscode-extension
Vscode Language Pascal
Pascal language extension for Visual Studio Code
Stars: ✭ 117 (-10%)
Mutual labels:  vscode, vscode-extension
Betterfountain
A screenwriting app integrated into visual studio code
Stars: ✭ 99 (-23.85%)
Mutual labels:  vscode, vscode-extension
Vscode Rss
An RSS reader embedded in Visual Studio Code
Stars: ✭ 102 (-21.54%)
Mutual labels:  vscode, vscode-extension
I18n Ally
🌍 All in one i18n extension for VS Code
Stars: ✭ 1,931 (+1385.38%)
Mutual labels:  vscode, vscode-extension
Vscode Go
Go extension for Visual Studio Code
Stars: ✭ 2,268 (+1644.62%)
Mutual labels:  vscode, vscode-extension

Markdown-TOC

Generate TOC (table of contents) of headlines from parsed markdown file.

1. Features

  • 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 and depthTo: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).

2. Installation

ext install markdown-toc

3. Usage

3.1. Insert TOC

Insert TOC

3.2. Insert Header Number Sections

Tips:Section of header is begin with depthFrom

Insert Header Number Sections

4. Configuration

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

4.1. Default Settings

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

4.2. Unique Settings

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 -->

5. Contributors

  • 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)

6. What's New?

CHANGELOG

7. Question

If you have any question, you can contact with me:

8. License

The package is Open Source Software released under the MIT License. It's developed by AlanWalk.

9. Links

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].