├── .github
    ├── CONTRIBUTING.md
    ├── ISSUE_TEMPLATE.md
    ├── ISSUE_TEMPLATE
    │   ├── feature.md
    │   └── question.md
    └── PULL_REQUEST_TEMPLATE.md
├── .gitignore
├── .markdownlint.json
├── .python-version
├── .travis.yml
├── LICENSE-MIT
├── Main.sublime-menu
├── MarkdownTOC.sublime-commands
├── MarkdownTOC.sublime-settings
├── README.md
├── Vagrantfile
├── __init__.py
├── appveyor.yml
├── images
    ├── capture.gif
    ├── how_to_remove_the_toc.gif
    └── title.gif
├── markdowntoc
    ├── __init__.py
    ├── autorunner.py
    ├── base.py
    ├── id.py
    ├── markdowntoc_insert.py
    ├── markdowntoc_update.py
    └── util.py
├── messages.json
├── messages
    ├── 1.2.1.md
    ├── 1.3.0.md
    ├── 1.4.0.md
    ├── 1.5.0.md
    ├── 1.6.0.md
    ├── 1.7.0.md
    ├── 1.8.0.md
    ├── 2.0.0.md
    ├── 2.1.0.md
    ├── 2.1.1.md
    ├── 2.1.2.md
    ├── 2.2.0.md
    ├── 2.2.1.md
    ├── 2.3.0.md
    ├── 2.3.1.md
    ├── 2.3.2.md
    ├── 2.4.0.md
    ├── 2.4.1.md
    ├── 2.5.0.md
    ├── 2.6.0.md
    ├── 2.7.0.md
    ├── 2.7.1.md
    ├── 2.7.2.md
    ├── 2.7.3.md
    ├── 2.8.0.md
    ├── 3.0.0.md
    ├── 3.0.1.md
    ├── 3.0.2.md
    ├── 3.0.3.md
    ├── 3.0.4.md
    ├── 3.0.5.md
    ├── 4.0.0.md
    ├── 4.0.1.md
    ├── 4.0.2.md
    ├── 4.1.0.md
    ├── 4.1.1.md
    ├── 4.1.2.md
    └── install.md
├── tests
    ├── autoanchor.py
    ├── autolink.py
    ├── base.py
    ├── bracket.py
    ├── default.py
    ├── exclude_heading.py
    ├── github_flavored_markdown.py
    ├── indent.py
    ├── italic_in_heading.py
    ├── levels.py
    ├── link_prefix.py
    ├── list_bullets.py
    ├── lowercase.py
    ├── markdown_preview.py
    ├── quotes_in_attributes.py
    ├── remove_image.py
    ├── style.py
    ├── tag_variation.py
    └── uri_encoding.py
└── unittesting.json


/.github/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Contributing
 2 | 
 3 | These are the guidelines for contributing to this repository.
 4 | 
 5 | ## Issues
 6 | 
 7 | Please use the template for your type of issue.
 8 | 
 9 | - [Bug Report](https://github.com/naokazuterada/MarkdownTOC/issues/new)
10 | - [Feature Request](https://github.com/naokazuterada/MarkdownTOC/issues/new?template=feature.md)
11 | - [Question](https://github.com/naokazuterada/MarkdownTOC/issues/new?template=question.md)
12 | 
13 | ### Way of operation
14 | 
15 | 1. The maintainers will `Close` the issue or PR
16 |     1. Not accepted feature request
17 |         - Add the `wontfix` label
18 |     2. Not clear or unresponsive
19 |         - Not clear: Problem is not obvious or not reproducible.
20 |         - Unresponsive: the author does not respond to inquiries within 3 weeks.
21 | 
22 | ## Gitter
23 | 
24 | If you want more general support or to ask questions, please use [Gitter](https://gitter.im/naokazuterada/MarkdownTOC) chat system.
25 | 
26 | ## Patches
27 | 
28 | Patches for fixes, features, and improvements are accepted via pull requests.
29 | 
30 | Pull requests should be based on the master branch, unless you want to contribute to an active branch for a specific topic.
31 | 
32 | ### Coding Style
33 | 
34 | You should use [Black](https://github.com/psf/black) for automatic code formatting.
35 | 
36 | ```
37 | pip install black
38 | black .
39 | ```
40 | 
41 | ### Test
42 | 
43 | You should use unit-tests for SublimeText by using [UnitTesting](https://github.com/randy3k/UnitTesting) plugin.
44 | 
45 | 1. Install the UnitTesting plugin
46 | 2. Comment out or rename your own `MarkdownTOC.sublime-settings` so individual settings are not used during testing
47 | 3. [Run tests](https://github.com/randy3k/UnitTesting-example#running-tests)
48 | 4. Send Pull Request when tests pass
49 | 
50 | All contributions are welcome
51 | 
52 | ## Useful Tools
53 | 
54 | - [Gyazo](https://gyazo.com/en): Tool for making animated GIFs from screen captures. Use it for showing how the function works.
55 | 
56 | ## Licensing and copyright
57 | 
58 | Please note that accepted contributions are included in the repository and hence under the same license as the repository contributed to.
59 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE.md:
--------------------------------------------------------------------------------
 1 | <!--
 2 | 
 3 | Template: BUG REPORT
 4 | 
 5 | This is a template for a bug report.
 6 | You should label `bug-report`.
 7 | 
 8 | 
 9 | If your issue is not a bug report, please visit one of the following links.
10 | 
11 | FEATURE REQUEST:
12 | https://github.com/naokazuterada/MarkdownTOC/issues/new?template=feature.md
13 | 
14 | QUESTION:
15 | https://github.com/naokazuterada/MarkdownTOC/issues/new?template=question.md
16 | 
17 | -->
18 | 
19 | # How can the issue be reproduced
20 | 
21 | # What was expected
22 | 
23 | # What actually occurred
24 | 
25 | # What was the version of the involved component


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature.md:
--------------------------------------------------------------------------------
 1 | <!--
 2 | 
 3 | Template: FEATURE REQUEST
 4 | 
 5 | This is a template for a feature request.
 6 | You should label `feature-request`.
 7 | 
 8 | 
 9 | If your issue is not a feature request, please visit one of the following links.
10 | 
11 | BUG REPORT:
12 | https://github.com/naokazuterada/MarkdownTOC/issues/new?template=bug.md
13 | 
14 | QUESTION:
15 | https://github.com/naokazuterada/MarkdownTOC/issues/new?template=question.md
16 | 
17 | -->
18 | 
19 | # Purpose
20 | 
21 | # How important it is
22 | 
23 | # Ideal implementation
24 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/question.md:
--------------------------------------------------------------------------------
 1 | <!--
 2 | 
 3 | Template: QUESTION
 4 | 
 5 | This is a template for a general question
 6 | You should label `question`.
 7 | 
 8 | 
 9 | If your issue is not a question, please visit one of the following links.
10 | 
11 | BUG REPORT:
12 | https://github.com/naokazuterada/MarkdownTOC/issues/new?template=bug.md
13 | 
14 | FEATURE REQUEST:
15 | https://github.com/naokazuterada/MarkdownTOC/issues/new?template=feature.md
16 | 
17 | -->
18 | 
19 | # Question
20 | 


--------------------------------------------------------------------------------
/.github/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
1 | <!--
2 | You should use unit-tests for SublimeText by using [UnitTesting](https://github.com/randy3k/UnitTesting) plugin.
3 | 
4 | 1. Install the UnitTesting plugin
5 | 2. Comment out or rename your own `MarkdownTOC.sublime-settings` so individual settings are not used during testing
6 | 3. [Run tests](https://github.com/randy3k/UnitTesting-example#running-tests)
7 | 4. Send Pull Request when tests pass
8 | -->


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | package-metadata.json
2 | .DS_Store
3 | .vagrant
4 | *.pyc
5 | *.pyo


--------------------------------------------------------------------------------
/.markdownlint.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "first-line-h1": false,
 3 |     "line-length": false,
 4 |     "html": false,
 5 |     "blanks-around-headings": false,
 6 |     "heading-style": false,
 7 |     "ul-indent": false,
 8 |     "blanks-around-fences": false
 9 | }
10 | 


--------------------------------------------------------------------------------
/.python-version:
--------------------------------------------------------------------------------
1 | 3.8
2 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | env:
 2 |     global:
 3 |         - PACKAGE="MarkdownTOC" # Package name
 4 |         - SUBLIME_TEXT_VERSION="3"
 5 |         # use UNITTESTING_TAG to specific tag of UnitTesting
 6 |         # - UNITTESTING_TAG="master"
 7 | 
 8 | # mutliple os matrix
 9 | # https://docs.travis-ci.com/user/multi-os/#Python-example-(unsupported-languages)
10 | matrix:
11 |     include:
12 |         - os: linux
13 |           services: xvfb
14 |           language: python
15 |           python: 3.7
16 |         - os: osx
17 |           language: generic
18 | 
19 | 
20 | before_install:
21 |     - curl -OL https://raw.githubusercontent.com/SublimeText/UnitTesting/master/sbin/travis.sh
22 |     # enable gui, see https://docs.travis-ci.com/user/gui-and-headless-browsers
23 |     - if [ "$TRAVIS_OS_NAME" == "linux"  ]; then
24 |             export DISPLAY=:99.0;
25 |             sh -e /etc/init.d/xvfb start;
26 |             sleep 3;
27 |       fi
28 | 
29 | install:
30 |     # bootstrap the testing environment
31 |     - sh travis.sh bootstrap
32 |     # install Package Control and package denepdencies
33 |     # - sh travis.sh install_package_control
34 | 
35 | script:
36 |     # run tests with test coverage report
37 |     - sh travis.sh run_tests --coverage
38 |     # testing syntax_test files
39 |     # - sh travis.sh run_syntax_tests
40 | 
41 | after_success:
42 |     - if [ "$TRAVIS_OS_NAME" == "osx" ]; then
43 |             brew update;
44 |             brew install python3;
45 |             pip3 install codecov;
46 |       fi
47 |     - if [ "$TRAVIS_OS_NAME" == "linux" ]; then
48 |             pip install codecov;
49 |       fi
50 |     - codecov -t e41883b8-547a-4728-a703-d8e1bbedfcf8
51 | 
52 | notifications:
53 |     email: true
54 | 


--------------------------------------------------------------------------------
/LICENSE-MIT:
--------------------------------------------------------------------------------
 1 | The MIT License
 2 | 
 3 | Copyright (c) 2013 Naokazu Terada
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 6 | 
 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 8 | 
 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
10 | 


--------------------------------------------------------------------------------
/Main.sublime-menu:
--------------------------------------------------------------------------------
 1 | [
 2 |   {
 3 |     "id": "tools",
 4 |     "children":
 5 |     [
 6 |       {
 7 |         "caption": "MarkdownTOC",
 8 |         "children":
 9 |         [
10 |           { 
11 |             "caption": "Insert TOC", 
12 |             "command": "markdowntoc_insert"
13 |           },
14 |           { 
15 |           	"caption": "Update TOC", 
16 |           	"command": "markdowntoc_update"
17 |           }
18 |         ]
19 |       }
20 |     ]
21 | },
22 | {
23 |   "caption": "Preferences",
24 |   "mnemonic": "n",
25 |   "id": "preferences",
26 |   "children":
27 |   [
28 |     {
29 |         "caption": "Package Settings",
30 |         "mnemonic": "P",
31 |         "id": "package-settings",
32 |         "children":
33 |         [
34 |           {
35 |             "caption": "MarkdownTOC Settings",
36 |             "command": "edit_settings",
37 |             "args": {"base_file": "${packages}/MarkdownTOC/MarkdownTOC.sublime-settings"},
38 |           }
39 |         ]
40 |       }
41 |     ]
42 |   }
43 | ]


--------------------------------------------------------------------------------
/MarkdownTOC.sublime-commands:
--------------------------------------------------------------------------------
1 | [
2 |   { "caption": "MarkdownTOC:Insert TOC", "command": "markdowntoc_insert" },
3 |   { "caption": "MarkdownTOC:Update TOC", "command": "markdowntoc_update" }
4 | ]


--------------------------------------------------------------------------------
/MarkdownTOC.sublime-settings:
--------------------------------------------------------------------------------
 1 | {
 2 |   "defaults": {
 3 |     "autoanchor": false,
 4 |     "autolink": false,
 5 |     "bracket": "round",
 6 |     "levels": [1,2,3,4,5,6],
 7 |     "indent": "\t",
 8 |     "remove_image": true,
 9 |     "link_prefix": "",
10 |     "bullets": ["-"],
11 |     "lowercase": "only_ascii",
12 |     "style": "unordered",
13 |     "uri_encoding": true,
14 |     "markdown_preview": ""
15 |   },
16 |   "id_replacements": [
17 |     {
18 |       "pattern": "\\s+",
19 |       "replacement": "-"
20 |     },
21 |     {
22 |       "pattern": "&lt;|&gt;|&amp;|&apos;|&quot;|&#60;|&#62;|&#38;|&#39;|&#34;|!|#|$|&|'|\\(|\\)|\\*|\\+|,|/|:|;|=|\\?|@|\\[|\\]|`|\"|\\.|\\\\|<|>|{|}|™|®|©|%",
23 |       "replacement": ""
24 |     }
25 |   ],
26 |   "logging": false
27 | }
28 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
   1 | ![MarkdownTOC](./images/title.gif)
   2 | 
   3 | ![Demo animation of the toc generation](./images/capture.gif)
   4 | 
   5 | MarkdownTOC
   6 | ===========
   7 | 
   8 | Sublime Text 3 plugin for generating a Table of Contents (TOC) in a Markdown document.
   9 | 
  10 | [![Linux and macOS Build Status](https://api.travis-ci.org/naokazuterada/MarkdownTOC.svg?branch=master&label=Linux+and+macOS+build "Linux and macOS Build Status")](https://travis-ci.org/naokazuterada/MarkdownTOC) [![Windows Build Status](https://ci.appveyor.com/api/projects/status/vxj9jbihlrwfa6ui/branch/master?svg=true&label=Windows+build "Windows Build Status")](https://ci.appveyor.com/project/naokazuterada/markdowntoc/branch/master) [![codecov](https://codecov.io/gh/naokazuterada/MarkdownTOC/branch/master/graph/badge.svg)](https://codecov.io/gh/naokazuterada/MarkdownTOC) [![Package Control](https://packagecontrol.herokuapp.com/downloads/MarkdownTOC.svg)](https://packagecontrol.io/packages/MarkdownTOC) [![Gitter chat](https://badges.gitter.im/naokazuterada/MarkdownTOC.png)](https://gitter.im/naokazuterada/MarkdownTOC)
  11 | 
  12 | ---
  13 | 
  14 | ***Note: v3.0.0 has breaking changes. See [Upgrade Guide](https://github.com/naokazuterada/MarkdownTOC/releases/tag/3.0.0) for more detail.***
  15 | 
  16 | ---
  17 | 
  18 | ## Table of Contents
  19 | 
  20 | <details>
  21 |  <summary>Click to open TOC</summary>
  22 | <!-- MarkdownTOC autolink="true" levels="1,2,3,4,5,6" bracket="round" style="unordered" indent="    " autoanchor="false" markdown_preview="github" -->
  23 | 
  24 | - [Quick Start](#quick-start)
  25 | - [Features](#features)
  26 |     - [Insertion of TOC based on headings in Markdown document](#insertion-of-toc-based-on-headings-in-markdown-document)
  27 |     - [Automatic refresh of TOC when Markdown document is saved](#automatic-refresh-of-toc-when-markdown-document-is-saved)
  28 |         - [Supported file extensions](#supported-file-extensions)
  29 |     - [Customizing generation of TOC using attributes](#customizing-generation-of-toc-using-attributes)
  30 |     - [Auto anchoring when heading has anchor defined](#auto-anchoring-when-heading-has-anchor-defined)
  31 |     - [Auto linking for _clickable_ TOC](#auto-linking-for-_clickable_-toc)
  32 |         - [Lowercasing in ids](#lowercasing-in-ids)
  33 |             - [Preserve case](#preserve-case)
  34 |             - [Lowercase all characters](#lowercase-all-characters)
  35 |         - [Manipulation of auto link ids](#manipulation-of-auto-link-ids)
  36 |         - [URI encoding](#uri-encoding)
  37 |         - [Markdown Preview compatible](#markdown-preview-compatible)
  38 |         - [Link Prefix](#link-prefix)
  39 |     - [Control of levels listed in TOC](#control-of-levels-listed-in-toc)
  40 |     - [Ordered or unordered style for TOC elements](#ordered-or-unordered-style-for-toc-elements)
  41 |     - [Customizable list bullets in TOC](#customizable-list-bullets-in-toc)
  42 |     - [Specify custom indentation prefix](#specify-custom-indentation-prefix)
  43 |     - [Preserve images in headings](#preserve-images-in-headings)
  44 |     - [Excluded headings](#excluded-headings)
  45 | - [Usage](#usage)
  46 | - [Tips](#tips)
  47 |     - [How to remove anchors added by MarkdownTOC](#how-to-remove-anchors-added-by-markdowntoc)
  48 |     - [Addressing issues with Github Pages](#addressing-issues-with-github-pages)
  49 |     - [Using MarkdownTOC with Markdownlint](#using-markdowntoc-with-markdownlint)
  50 | - [Limitations](#limitations)
  51 |     - [Headings in lists are not included in the auto-generated table of contents](#headings-in-lists-are-not-included-in-the-auto-generated-table-of-contents)
  52 | - [Attributes](#attributes)
  53 | - [Installation](#installation)
  54 |     - [Using Package Control](#using-package-control)
  55 |     - [From Git](#from-git)
  56 |     - [From downloadable archive](#from-downloadable-archive)
  57 | - [Configuration](#configuration)
  58 |     - [Github Configuration](#github-configuration)
  59 |     - [Configuration and Collaboration](#configuration-and-collaboration)
  60 | - [Compatibility](#compatibility)
  61 | - [Contributing](#contributing)
  62 | - [License](#license)
  63 | - [Author](#author)
  64 | - [References](#references)
  65 |     - [Markdown Table of Contents Generators](#markdown-table-of-contents-generators)
  66 |     - [Recommended plugins for use with MarkdownTOC](#recommended-plugins-for-use-with-markdowntoc)
  67 | 
  68 | <!-- /MarkdownTOC -->
  69 | </details>
  70 | 
  71 | ## Quick Start
  72 | 
  73 | 1. [Install](#installation) the **MarkdownTOC** plugin
  74 | 1. Open your [Markdown] file
  75 | 1. Place the cursor at the position where you want to insert the TOC
  76 | 1. Pick from menu: Tools > MarkdownTOC > Insert TOC
  77 | 1. And the TOC is inserted in the [Markdown] document
  78 | 1. Save the document and you are done
  79 | 
  80 | Now you can go on and edit your document further or you can customize you TOC, please read on.
  81 | 
  82 | ## Features
  83 | 
  84 | The **MarkdownTOC** plugin is rich on features and customization, useful for both work on a single [Markdown] document or if you have several [Markdown] documents that require _special_ TOC generation.
  85 | 
  86 | - [Insertion of TOC based on headings in Markdown document](#insertion-of-toc-based-on-headings-in-markdown-document)
  87 | - [Automatic refresh of TOC when Markdown document is saved](#automatic-refresh-of-toc-when-markdown-document-is-saved)
  88 | - [Customizing generation of TOC using attributes](#customizing-generation-of-toc-using-attributes)
  89 | - [Auto anchoring when heading has anchor defined](#auto-anchoring-when-heading-has-anchor-defined)
  90 | - [Auto linking for _clickable_ TOC](#auto-linking-for-clickable-toc)
  91 |     - [Lowercasing in ids](#lowercasing-in-ids)
  92 |         - [Preserve case](#preserve-case)
  93 |         - [Lowercase all characters](#lowercase-all-characters)
  94 |     - [Manipulation of auto link ids](#manipulation-of-auto-link-ids)
  95 |     - [URI encoding](#uri-encoding)
  96 |     - [Markdown Preview compatible](#markdown-preview-compatible)
  97 |     - [Link Prefix](#link-prefix)
  98 | - [Control of levels listed in TOC](#control-of-levels-listed-in-toc)
  99 | - [Ordered or unordered style for TOC elements](#ordered-or-unordered-style-for-toc-elements)
 100 | - [Customizable list bullets in TOC](#customizable-list-bullets-in-toc)
 101 | - [Specify custom indentation prefix](#specify-custom-indentation-prefix)
 102 | - [Preserve images in headings](#preserve-images-in-headings)
 103 | - [Excluded headings](#excluded-heading)
 104 | 
 105 | ### Insertion of TOC based on headings in Markdown document
 106 | 
 107 | When you have completed the [installation](#installation) of the plugin, you can insert an automatically generated TOC based on your [Markdown] headings. See the [Quick Start](#quick-start) to get going or the [Usage section](#usage) for details on how to utilize customization and [configuration](#configuration).
 108 | 
 109 | For the following sample [Markdown] document:
 110 | 
 111 | ```markdown
 112 | 
 113 | # Heading 0
 114 | 
 115 | Headings before MarkdownTOC tags will be ignored.
 116 | 
 117 | ◀ place the cursor here and generate the TOC
 118 | 
 119 | # Heading 1
 120 | Lorem ipsum...
 121 | 
 122 | ## Heading 2
 123 | Lorem ipsum...
 124 | ```
 125 | 
 126 | The **MarkdownTOC** plugin will out of the box generate:
 127 | 
 128 | ```markdown
 129 | # Heading 0
 130 | 
 131 | Headings before MarkdownTOC tags will be ignored.
 132 | 
 133 | <!-- MarkdownTOC -->
 134 | 
 135 | - Heading 1
 136 |   - Heading 2
 137 | 
 138 | <!-- /MarkdownTOC -->
 139 | 
 140 | # Heading 1
 141 | Lorem ipsum...
 142 | 
 143 | ## Heading 2
 144 | Lorem ipsum...
 145 | ```
 146 | 
 147 | As you can read from the sample above:
 148 | 
 149 | 1. Headings above the `MarkdownTOC` tag section are ignored, only the rest of the document is considered _in scope_
 150 | 
 151 | ### Automatic refresh of TOC when Markdown document is saved
 152 | 
 153 | If we edit the [Markdown] document some more and add an additional heading:
 154 | 
 155 | ```markdown
 156 | ## Heading 3
 157 | ```
 158 | 
 159 | When we save the document, the TOC is automatically updated.
 160 | 
 161 | ```markdown
 162 | <!-- MarkdownTOC -->
 163 | 
 164 | - Heading 1
 165 |   - Heading 2
 166 |   - Heading 3
 167 | 
 168 | <!-- /MarkdownTOC -->
 169 | 
 170 | # Heading 1
 171 | Lorem ipsum...
 172 | 
 173 | ## Heading 2
 174 | Lorem ipsum...
 175 | 
 176 | ## Heading 3
 177 | Lorem ipsum... (the added text)
 178 | ```
 179 | 
 180 | Same goes for deleted headings, these are cleared out.
 181 | 
 182 | Updating the TOC can also be accomplished without saving by picking from the menu: Tools > MarkdownTOC > Update TOC
 183 | 
 184 | #### Supported file extensions
 185 | 
 186 | Make sure your file's extension is in the following list.
 187 | 
 188 | `.md` `.markdown` `.mdown` `.mdwn` `.mkdn` `.mkd` `.mark`
 189 | 
 190 | ### Customizing generation of TOC using attributes
 191 | 
 192 | ```markdown
 193 | <!-- MarkdownTOC autolink="true" -->
 194 | 
 195 | - [Heading 1](#heading-1)
 196 |   - [Heading 2](#heading-2)
 197 |   - [Heading 3](#heading-3)
 198 | 
 199 | <!-- /MarkdownTOC -->
 200 | 
 201 | # Heading 1
 202 | Lorem ipsum...
 203 | 
 204 | ## Heading 2
 205 | Lorem ipsum...
 206 | 
 207 | ## Heading 3
 208 | Lorem ipsum... (the added text)
 209 | ```
 210 | 
 211 | 1. TOC tags can overwrite default [attributes](#Attributes) using local settings and influence the rendering of the TOC. See: [Configuration](#configuration) on how to set your own defaults for the plugin
 212 | 1. Headings can be automatically linked (see: [auto link](#auto-link))
 213 | 1. Headings can have anchors automatically linked (see: [Auto anchoring when heading has anchor defined](#auto-anchoring-when-heading-has-anchor-defined))
 214 | 
 215 | The default behaviour could also be described as:
 216 | 
 217 | ```markdown
 218 | <!-- MarkdownTOC levels="1,2,3,4,5,6" autolink="false" bracket="round" autoanchor="false" style="unordered" indent="\t" -->
 219 | ```
 220 | 
 221 | Please see: [Github Configuration](#github-configuration) for a guideline to configuring **MarkdownTOC** for [Github] use.
 222 | 
 223 | ### Auto anchoring when heading has anchor defined
 224 | 
 225 | You can add an HTML anchor (`<a name="xxx"></a>`) before your heading automatically.
 226 | 
 227 | ```markdown
 228 | # Heading with anchor [with-anchor]
 229 | ```
 230 | 
 231 | The TOC generation can be specified to respect this and a TOC element of the following format is generated:
 232 | 
 233 | ```markdown
 234 | - [Heading with anchor](#with-anchor)
 235 | ```
 236 | 
 237 | Please note that the default for the attribute: [autoanchor](#autoanchor) is `false`.You can add an HTML anchor (`<a name="xxx"></a>`) before the heading automatically.
 238 | 
 239 | ```markdown
 240 | <!-- MarkdownTOC autolink="true" autoanchor="true" -->
 241 | 
 242 | - [Changelog](#changelog)
 243 | - [Glossary](#glossary)
 244 | - [API Specification](#api-specification)
 245 | 
 246 | <!-- /MarkdownTOC -->
 247 | 
 248 | <a name="changelog"></a>
 249 | # Changelog
 250 | Lorem ipsum...
 251 | 
 252 | <a name="glossary"></a>
 253 | # Glossary
 254 | Lorem ipsum...
 255 | 
 256 | <a name="api-specification"></a>
 257 | # API Specification
 258 | Lorem ipsum...
 259 | ```
 260 | 
 261 | Please note that the default for autolink is `false` defined by the [attribute](#attributes) `defaults.autoanchor`. See also: [How to remove anchors added by MarkdownTOC](#how-to-remove-anchors-added-by-markdowntoc).
 262 | 
 263 | ### Auto linking for _clickable_ TOC
 264 | 
 265 | The plugin can be specified to auto link heading so you get a TOC with _clickable_ hyperlink elements.
 266 | 
 267 | The following sample document:
 268 | 
 269 | ```markdown
 270 | # Heading 1
 271 | Lorem ipsum...
 272 | 
 273 | ## Heading 2
 274 | Lorem ipsum...
 275 | 
 276 | ## Heading 3
 277 | Lorem ipsum...
 278 | ```
 279 | 
 280 | With `autolink` set to `true` will render the following:
 281 | 
 282 | ```markdown
 283 | <!-- MarkdownTOC autolink="true" -->
 284 | 
 285 | - [Heading 1](#heading-1)
 286 |   - [Heading 2](#heading-2)
 287 |   - [Heading 3](#heading-3)
 288 |   - [Heading 4](#heading-4)
 289 | - [Heading with anchor](#with-anchor)
 290 | 
 291 | <!-- /MarkdownTOC -->
 292 | ```
 293 | 
 294 | The auto link markup style can be one of:
 295 | 
 296 | - `round`, the default, the style supported on [Github]
 297 | - `square`, the ["Markdown standard reference-style links"][MarkdownLinks] style.
 298 | 
 299 | Please note that the default for autolink is `false` defined by the [attribute](#attributes) `defaults.autolink`.
 300 | 
 301 | ```markdown
 302 | <!-- MarkdownTOC autolink="false" -->
 303 | 
 304 | - MarkdownTOC Plugin for Sublime Text
 305 |   - Feature
 306 |   - Feature
 307 |   - Feature
 308 | 
 309 | <!-- /MarkdownTOC -->
 310 | ```
 311 | ```markdown
 312 | <!-- MarkdownTOC autolink="true" -->
 313 | 
 314 | - [MarkdownTOC Plugin for Sublime Text](#markdowntoc-plugin-for-sublime-text)
 315 |   - [Feature](#feature)
 316 |   - [Feature](#feature-1)
 317 |   - [Feature](#feature-2)
 318 | 
 319 | <!-- /MarkdownTOC -->
 320 | ```
 321 | 
 322 | **round**: according to [Github] style.
 323 | 
 324 | ```markdown
 325 | <!-- MarkdownTOC bracket="round" -->
 326 | 
 327 | - [Heading](#heading)
 328 | 
 329 | <!-- /MarkdownTOC -->
 330 | ```
 331 | 
 332 | **square**: according to ["Markdown standard reference-style links"][MarkdownLinks].
 333 | 
 334 | ```markdown
 335 | <!-- MarkdownTOC bracket="square" -->
 336 | 
 337 | - [Heading][heading]
 338 | 
 339 | <!-- /MarkdownTOC -->
 340 | ```
 341 | 
 342 | Please note that the default for bracket is `round` defined by the [attribute](#attributes) `defaults.bracket`.
 343 | 
 344 | #### Lowercasing in ids
 345 | 
 346 | By default the plugin lowercases ASCII based alphabets **only** (`a` to `z`) for auto links.
 347 | 
 348 | ```markdown
 349 | <!-- MarkdownTOC autolink="true" -->
 350 | 
 351 | - [ПРИМЕР EXAMPLE][ПРИМЕР-example]
 352 | 
 353 | <!-- /MarkdownTOC -->
 354 | 
 355 | # ПРИМЕР EXAMPLE
 356 | ```
 357 | 
 358 | This is same as setting `lowercase` attribute to `only_ascii`.
 359 | 
 360 | ```markdown
 361 | <!-- MarkdownTOC autolink="true" lowercase="only_ascii" -->
 362 | 
 363 | - [ПРИМЕР EXAMPLE][ПРИМЕР-example]
 364 | 
 365 | <!-- /MarkdownTOC -->
 366 | 
 367 | # ПРИМЕР EXAMPLE
 368 | ```
 369 | 
 370 | ##### Preserve case
 371 | 
 372 | You can disable the lowercasing capability by setting the `lowecase` attribute to `false`.
 373 | 
 374 | ```markdown
 375 | <!-- MarkdownTOC autolink="true" lowercase="false" -->
 376 | 
 377 | - [One Two Three][One-Two-Three]
 378 | 
 379 | <!-- /MarkdownTOC -->
 380 | 
 381 | # One Two Three
 382 | ```
 383 | 
 384 | ##### Lowercase all characters
 385 | 
 386 | Further more you can also expand the lowercasing capability by setting the `lowercase` attribute to `all`(or any values other than `false` and `only_ascii`).
 387 | 
 388 | ```markdown
 389 | <!-- MarkdownTOC autolink="true" lowercase="all" -->
 390 | 
 391 | - [ПРИМЕР EXAMPLE][пример-example]
 392 | 
 393 | <!-- /MarkdownTOC -->
 394 | 
 395 | # ПРИМЕР EXAMPLE
 396 | ```
 397 | 
 398 | You can also specify this in your [configuration](#configuration) with key `defaults.lowercase`.
 399 | 
 400 | #### Manipulation of auto link ids
 401 | 
 402 | You can manipulate your link ids in your [configuration](#configuration) using the key `id_replacements`.
 403 | 
 404 | ```json
 405 | {
 406 |   "id_replacements": [
 407 |     {
 408 |       "pattern": "\\s+",
 409 |       "replacement": "-"
 410 |     },
 411 |     {
 412 |       "pattern": "!|#|$|&|'|\\(|\\)|\\*|\\+|,|/|:|;|=|_|\\?|@|\\[|\\]|`|\"|\\.|<|>|{|}|™|®|©|&lt;|&gt;|&amp;|&apos;|&quot;|&#60;|&#62;|&#38;|&#39;|&#34;",
 413 |       "replacement": ""
 414 |     }
 415 |   ]
 416 | }
 417 | ```
 418 | 
 419 | 1. Regular expression is allowed in each sets
 420 |     - It will be simply expanded into python's `re.sub(pattern, replacement, id)`
 421 | 2. The replacement sequence executes from top to bottom
 422 | 
 423 | An example:
 424 | 
 425 | ```markdown
 426 | # Super Product™
 427 | ```
 428 | 
 429 | This heading link of this heading is changed to following id
 430 | 
 431 | ```markdown
 432 | #super-product
 433 | ```
 434 | 
 435 | - The `' '` (space) is replaced with `-` (dash), since `' '` is included in the first set
 436 | - The '™' is replaced with _nothing_, since '™' is included in the second set
 437 | 
 438 | #### URI encoding
 439 | 
 440 | By default non-ASCII characters in link ids are [URL encoded](https://en.wikipedia.org/wiki/Percent-encoding).
 441 | 
 442 | ```markdown
 443 | <!-- MarkdownTOC autolink="true" -->
 444 | 
 445 | - [Ejemplos de español](#ejemplos-de-espa%C3%B1ol)
 446 | - [日本語の例](#%E6%97%A5%E6%9C%AC%E8%AA%9E%E3%81%AE%E4%BE%8B)
 447 | - [Примеры русского](#%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%D1%8B-%D1%80%D1%83%D1%81%D1%81%D0%BA%D0%BE%D0%B3%D0%BE)
 448 | - [中国的例子](#%E4%B8%AD%E5%9B%BD%E7%9A%84%E4%BE%8B%E5%AD%90)
 449 | 
 450 | <!-- /MarkdownTOC -->
 451 | 
 452 | # Ejemplos de español
 453 | # 日本語の例
 454 | # Примеры русского
 455 | # 中国的例子
 456 | ```
 457 | 
 458 | As mentioned you can disable this by setting the `uri_encoding` attribute to `false`, like so: `uri_encoding="false"`.
 459 | 
 460 | ```markdown
 461 | <!-- MarkdownTOC autolink="true" uri_encoding="false" -->
 462 | 
 463 | - [Ejemplos de español](#ejemplos-de-español)
 464 | - [日本語の例](#日本語の例)
 465 | - [Примеры русского](#Примеры-русского)
 466 | - [中国的例子](#中国的例子)
 467 | 
 468 | <!-- /MarkdownTOC -->
 469 | 
 470 | # Ejemplos de español
 471 | # 日本語の例
 472 | # Примеры русского
 473 | # 中国的例子
 474 | ```
 475 | 
 476 | #### Markdown Preview compatible
 477 | 
 478 | If you want to use **MarkdownTOC** with [Markdown Preview][MarkdownPreview], you should use `markdown_preview` attribute.
 479 | You can set this attribute to either `markdown` or `github`.
 480 | 
 481 | When you set it to `markdown`, you can get same links rendered by MarkdownPreview's markdown parser.
 482 | 
 483 | ```markdown
 484 | <!-- MarkdownTOC autolink="true" markdown_preview="markdown" -->
 485 | 
 486 | - [Hello 世界 World](#hello-world)
 487 | - [ESPAÑA](#espana)
 488 | - [ПРИМЕР RUSSIAN](#russian)
 489 | 
 490 | <!-- /MarkdownTOC -->
 491 | 
 492 | # Hello 世界 World
 493 | # ESPAÑA
 494 | # ПРИМЕР RUSSIAN
 495 | ```
 496 | 
 497 | When you set it to `github`, you can get same links rendered by MarkdownPreview's github parser.
 498 | 
 499 | ```markdown
 500 | <!-- MarkdownTOC autolink="true" markdown_preview="github" -->
 501 | 
 502 | - [Hello 世界 World](#hello-%25E4%25B8%2596%25E7%2595%258C-world)
 503 | - [ESPAÑA](#espa%25C3%25B1a)
 504 | - [ПРИМЕР RUSSIAN](#%25D0%25BF%25D1%2580%25D0%25B8%25D0%25BC%25D0%25B5%25D1%2580-russian)
 505 | 
 506 | <!-- /MarkdownTOC -->
 507 | 
 508 | # Hello 世界 World
 509 | # ESPAÑA
 510 | # ПРИМЕР RUSSIAN
 511 | ```
 512 | 
 513 | Currently no other parsers are supported.
 514 | 
 515 | If you want to disable this feature, set it to `false`.
 516 | 
 517 | #### Link Prefix
 518 | 
 519 | You can also set _prefix_ of links.
 520 | 
 521 | ```markdown
 522 | <!-- MarkdownTOC autolink=true link_prefix="user-content-" -->
 523 | 
 524 | - [My Heading](#user-content-my-heading)
 525 | 
 526 | <!-- /MarkdownTOC -->
 527 | 
 528 | # My Heading
 529 | ```
 530 | 
 531 | You can manipulate this in your [configuration](#configuration) using the key `defaults.link_prefix`.
 532 | 
 533 | ### Control of levels listed in TOC
 534 | 
 535 | ```markdown
 536 | # Heading 1
 537 | Lorem ipsum...
 538 | 
 539 | ## Heading 2
 540 | Lorem ipsum...
 541 | 
 542 | ### Heading 3
 543 | Lorem ipsum...
 544 | 
 545 | #### Heading 4
 546 | Lorem ipsum...
 547 | ```
 548 | 
 549 | With default levels:
 550 | 
 551 | ```markdown
 552 | <!-- MarkdownTOC -->
 553 | 
 554 | - Heading 1
 555 |   - Heading 2
 556 |     - Heading 3
 557 |       - Heading 4
 558 | 
 559 | <!-- /MarkdownTOC -->
 560 | ```
 561 | 
 562 | With levels set to 1,2:
 563 | 
 564 | ```markdown
 565 | <!-- MarkdownTOC levels="1,2" -->
 566 | 
 567 | - Heading 1
 568 |   - Heading 2
 569 | 
 570 | <!-- /MarkdownTOC -->
 571 | ```
 572 | 
 573 | Please note that the default for the [attribute](#attributes) levels is `"1,2,3,4,5,6"`, it means all heading sizes will be included.
 574 | 
 575 | You can also specify this in your [configuration](#configuration) with key `defaults.levels`.
 576 | 
 577 | The maximum size for headings is `6` according to the [Markdown specification][Markdown]
 578 | 
 579 | ### Ordered or unordered style for TOC elements
 580 | 
 581 | The plugin supports two styles of TOC element listing:
 582 | 
 583 | - `unordered`
 584 | - `ordered`
 585 | 
 586 | A [Markdown] document with the following contents:
 587 | 
 588 | ```markdown
 589 | # Heading 1
 590 | Lorem ipsum...
 591 | 
 592 | ## Heading 2
 593 | Lorem ipsum...
 594 | 
 595 | ### Heading 3
 596 | Lorem ipsum...
 597 | 
 598 | ### Heading 4
 599 | Lorem ipsum...
 600 | 
 601 | ## Heading 5
 602 | Lorem ipsum...
 603 | 
 604 | # Heading 6
 605 | Lorem ipsum...
 606 | ```
 607 | 
 608 | Will with style `unordered`:
 609 | 
 610 | ```markdown
 611 | <!-- MarkdownTOC style="unordered" -->
 612 | 
 613 | - Heading 1
 614 |   - Heading 2
 615 |     - Heading 3
 616 |     - Heading 4
 617 |   - Heading 5
 618 | - Heading 6
 619 | 
 620 | <!-- /MarkdownTOC -->
 621 | ```
 622 | 
 623 | And with style `ordered`:
 624 | 
 625 | ```markdown
 626 | <!-- MarkdownTOC style="ordered" -->
 627 | 
 628 | 1. Heading 1
 629 |   1. Heading 2
 630 |     1. Heading 3
 631 |     1. Heading 4
 632 |   1. Heading 5
 633 | 1. Heading 6
 634 | 
 635 | <!-- /MarkdownTOC -->
 636 | ```
 637 | 
 638 | Please note that the default for the [attribute](#attributes) is: `unordered`.
 639 | 
 640 | You can set your default style in your [configuration](#configuration) with the key `defaults.style`.
 641 | 
 642 | ### Customizable list bullets in TOC
 643 | 
 644 | You can define the list items used for the TOC for each level. The first item is for the first level, the second for the second and so on until the last one of the list and then it starts over from the beginning.
 645 | 
 646 | ```markdown
 647 | <!-- MarkdownTOC bullets="-,+,*" -->
 648 | 
 649 | - foo
 650 |   + bar
 651 |     * baz
 652 |       - foo
 653 |         + bar
 654 |           * baz
 655 | 
 656 | <!-- /MarkdownTOC -->
 657 | ```
 658 | 
 659 | You can set default list bullets in your [configuration](#configuration) with the key `defaults.bullets`.
 660 | 
 661 | The example above could also be described as:
 662 | 
 663 | ```json
 664 | {
 665 |   "defaults": {
 666 |     "bullets": ["-","+","*"]
 667 |   }
 668 | }
 669 | ```
 670 | 
 671 | You can also set it in attribute. In this case the values type is **'conmma separated string'**.
 672 | 
 673 | ```markdown
 674 | <!-- MarkdownTOC bullets="-,+,*" -->
 675 | ```
 676 | 
 677 | ### Specify custom indentation prefix
 678 | 
 679 | The indentation prefix is a specification of the string used to indent the TOC elements.
 680 | 
 681 | An _ugly_ but demonstrative example could be to use an [emoji][emoji].
 682 | 
 683 | ```markdown
 684 | <!-- MarkdownTOC autolink="true" indent=":point_right: " -->
 685 | 
 686 | - [Heading 1](#heading-1)
 687 | :point_right: - [Heading 2](#heading-2)
 688 | :point_right: :point_right: - [Heading 3](#heading-3)
 689 | :point_right: :point_right: - [Heading 4](#heading-4)
 690 | :point_right: - [Heading 5](#heading-5)
 691 | - [Heading 6](#heading-6)
 692 | 
 693 | <!-- /MarkdownTOC -->
 694 | ```
 695 | 
 696 | Please note that the default for the [attribute](#attributes) is: `'\t'`.
 697 | 
 698 | You can set your default indentation in your [configuration](#configuration) with the key `defaults.indent`.
 699 | 
 700 | ### Preserve images in headings
 701 | 
 702 | If you want to preserve images in headings, set `remove_image` to `false`.
 703 | 
 704 | ```markdown
 705 | <!-- MarkdownTOC remove_image="false" -->
 706 | 
 707 | - ![check](check.png) Everything is OK
 708 | 
 709 | <!-- /MarkdownTOC -->
 710 | 
 711 | # ![check](check.png) Everything is OK
 712 | ```
 713 | 
 714 | Please note that the default for the [attribute](#attributes) is: `false`.
 715 | 
 716 | ```markdown
 717 | <!-- MarkdownTOC -->
 718 | 
 719 | - Everything is OK
 720 | 
 721 | <!-- /MarkdownTOC -->
 722 | 
 723 | # ![check](check.png) Everything is OK
 724 | ```
 725 | 
 726 | You can change your default setting in your [configuration](#configuration) with the key `defaults.remove_image`.
 727 | 
 728 | ### Excluded headings
 729 | 
 730 | You can exclude certain headings in the TOC by adding a special comment to the line above the line with the heading, as shown below.
 731 | 
 732 | ```markdown
 733 | <!-- MarkdownTOC:excluded -->
 734 | ## This heading will be excluded
 735 | ```
 736 | 
 737 | ## Usage
 738 | 
 739 | 1. Open your [Markdown] file
 740 | 2. Set cursor to position where you want to insert a TOC
 741 | 3. Pick from menu: Tools > MarkdownTOC > Insert TOC
 742 | 4. TOC is inserted in document
 743 | 5. Evaluate your TOC and customize using [attributes](#attributes) or [configuration](#configuration)
 744 | 6. Update contents and save...
 745 | 7. TOC has been updated
 746 | 
 747 | ***Don't remove the comment tags if you want to update every time saving.***
 748 | 
 749 | ## Tips
 750 | 
 751 | ### How to remove anchors added by MarkdownTOC
 752 | 
 753 | If you want to remove the TOC again, you do not have to go through your complete Markdown and remove all tags manually - just follow this simple guide (see also: [Auto anchoring when heading has anchor defined](#auto-anchoring-when-heading-has-anchor-defined)).
 754 | 
 755 | 1. Open your [Markdown] file
 756 | 2. Set the attribute `autoanchor` to `false`, this clears all anchors
 757 | 
 758 | ```markdown
 759 | <!-- MarkdownTOC autoanchor="false" -->
 760 | ```
 761 | 
 762 | Please see the below animation demonstrating the change
 763 | 
 764 | ![Demo animation of removal of toc](./images/how_to_remove_the_toc.gif)
 765 | 
 766 | <ol><li value="3">Now delete the TOC section from beginning to end and **MarkdownTOC** integration is gone</li></ol>
 767 | 
 768 | ```markdown
 769 | <!-- MarkdownTOC autoanchor="false" -->
 770 | 
 771 | ...
 772 | 
 773 | <!-- /MarkdownTOC -->
 774 | ```
 775 | 
 776 | Ref: [Github issue #76](https://github.com/naokazuterada/MarkdownTOC/issues/76)
 777 | 
 778 | ### Addressing issues with Github Pages
 779 | 
 780 | If you are using Github Pages you might experience that some themes do not render heading correctly.
 781 | 
 782 | This can be addressed simply by setting `autoanchor` to `false`
 783 | 
 784 | ```markdown
 785 | <!-- MarkdownTOC autoanchor="false" -->
 786 | ```
 787 | 
 788 | And when **Jekyll** is done, your headings should render correctly.
 789 | 
 790 | Ref: [Github issue #81](https://github.com/naokazuterada/MarkdownTOC/issues/81)
 791 | 
 792 | ### Using MarkdownTOC with Markdownlint
 793 | 
 794 | If you are using [Markdownlint](https://github.com/DavidAnson/markdownlint) (Node implementation), it will report several violations out of the box.
 795 | 
 796 | The basic configuration you can use to address these looks like the following:
 797 | 
 798 | ```json
 799 | {
 800 |     "html": false,
 801 |     "blanks-around-headings": false,
 802 |     "ul-indent": {
 803 |         "indent": 4
 804 |     }
 805 | }
 806 | ```
 807 | 
 808 | - `html` set to `false`, to allow use of HTML since **MarkdownTOC** relies on HTML tags to assist the Markdown
 809 | - `blanks-around-headings` should be set to `false`, since anchors are places closed to the headings that are listed in the TOC
 810 | - `ul-indent` should have it's parameter `indent` set to `4` to adhere with the default of `4` used by **MarkdownTOC**, whereas **Markdownlint** defaults to `2`
 811 | 
 812 | If you have configured **MarkdownTOC** differently, you can adjust your **Markdownlint** configuration accordingly.
 813 | 
 814 | Do note that this tip is based on the **Node** implementation, [available on GitHub](https://github.com/DavidAnson/markdownlint), which uses a project specific `.markdownlint.json` based configuration.
 815 | 
 816 | ## Limitations
 817 | 
 818 | **MarkdownTOC** does come with some limitations.
 819 | 
 820 | For more information on compatibility, please see [the dedicated section](#compatibility).
 821 | 
 822 | ### Headings in lists are not included in the auto-generated table of contents
 823 | 
 824 | Example of [Markdown] heading in a [Markdown] listing, not being included in the auto-generated Table of Contents
 825 | 
 826 | ```markdown
 827 | - # this is a heading
 828 | ```
 829 | 
 830 | ## Attributes
 831 | 
 832 | The following attributes can be used to control the generation of the TOC.
 833 | 
 834 | | attribute              | values                                    | default         |
 835 | |:-----------------------|:------------------------------------------|:----------------|
 836 | | `autoanchor`           | `true`or`false`                           | `false`         |
 837 | | `autolink`             | `true`or`false`                           | `false`         |
 838 | | `bracket`              | `"round"`or`"square"`                     | `"round"`       |
 839 | | `indent`               | string                                    | `"\t"`          |
 840 | | `levels`               | string (decimal list separated with `,`)  | `"1,2,3,4,5,6"` |
 841 | | `link_prefix`          | string                                    | `""`            |
 842 | | `bullets`              | string                                    | `"-"`           |
 843 | | `lowercase`            | `"all"`or`"only_ascii"`or`"false"`        | `"only_ascii"`  |
 844 | | `remove_image`         | `true`or`false`                           | `true`          |
 845 | | `style`                | `"ordered"` or `"unordered"`              | `"unordered"`   |
 846 | | `uri_encoding`         | `true`or`false`                           | `true`          |
 847 | | `markdown_preview`     | `""`or`"github"`or`"markdown"`            | `""`            |
 848 | 
 849 | You can define your own default values via package preferences, [Sublime Text][SublimeText]'s way of letting users customize [package settings][SublimeTextSettings]. Please see the [Section on Configuration](#Configuration) for more details for **MarkdownTOC**.
 850 | 
 851 | ## Installation
 852 | 
 853 | ### Using Package Control
 854 | 
 855 | 1. Run “Package Control: Install Package” command, find and install `MarkdownTOC` plugin.
 856 | 2. Restart [Sublime Text][SublimeText]
 857 | 
 858 | > [Package Control][PackageControl]
 859 | 
 860 | ### From Git
 861 | 
 862 | ```sh
 863 | git clone git@github.com:naokazuterada/MarkdownTOC.git ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/MarkdownTOC
 864 | ```
 865 | 
 866 | ### From downloadable archive
 867 | 
 868 | 1. [Download zip-file](https://github.com/naokazuterada/MarkdownTOC/archive/master.zip) and unpack it.
 869 | 2. Open the [Sublime Text][sublimetext] `Packages/` directory (pick menu: Sublime Text > Preferences > Browse Packages).
 870 | 3. Move the `MarkdownTOC/` directory into the `Packages/` directory.
 871 | 
 872 | ## Configuration
 873 | 
 874 | You can use [attributes](#attributes) to customize a TOC in a single [Markdown] document, but if you want to keep the same TOC configuration accross multiple [Markdown] documents, you can configure your own defaults.
 875 | 
 876 | Pick: `Sublime Text > Preferences > Package Settings > MarkdownTOC > Settings - User`
 877 | 
 878 | Alternatively you can create the file `~/Library/Application Support/Sublime Text 3/Packages/User/MarkdownTOC.sublime-settings` by hand.
 879 | 
 880 | Example: `MarkdownTOC.sublime-settings`
 881 | 
 882 | ```json
 883 | {
 884 |   "defaults": {
 885 |     "autolink": true,
 886 |     "bracket": "square",
 887 |     "levels": "1,2",
 888 |     "indent": "    ",
 889 |     "remove_image": false,
 890 |     "bullets": "*",
 891 |     "style": "ordered"
 892 |   },
 893 |   "id_replacements": [
 894 |     {
 895 |       "pattern": "\\s+",
 896 |       "replacement": "-"
 897 |     },
 898 |     {
 899 |       "pattern": "&lt;|&gt;|&amp;|&apos;|&quot;|&#60;|&#62;|&#38;|&#39;|&#34;|!|#|$|&|'|\\(|\\)|\\*|\\+|,|/|:|;|=|_|\\?|@|\\[|\\]|`|\"|\\.|<|>|{|}|™|®|©",
 900 |       "replacement": ""
 901 |     }
 902 |   ]
 903 | }
 904 | ```
 905 | 
 906 | Please see the section on [attributes](#attributes) for an overview of values and the [section on customization](#customizing-generation-of-toc-using-attributes).
 907 | 
 908 | Configuration precendence is as follows:
 909 | 
 910 | 1. Attributes specified in **MarkdownTOC** begin tag (see: [Customizing generation of TOC using attributes](#customizing-generation-of-toc-using-attributes))
 911 | 1. **MarkdownTOC** Settings - user (this section)
 912 | 1. **MarkdownTOC** Settings - default (see: [Attributes](#attributes))
 913 | 
 914 | For an overview of the specific behaviour behind an attribute, please refer to the below list.
 915 | 
 916 | - `defaults.autolink`, (see: [Auto linking for _clickable_ TOC](#auto-linking-for-clickable-toc))
 917 | - `defaults.autoanchor`, (see: [Auto anchoring when heading has anchor defined](#auto-anchoring-when-heading-has-anchor-defined))
 918 | - `defaults.bracket`, (see: [Auto linking for _clickable_ TOC](#auto-linking-for-clickable-toc))
 919 | - `defaults.indent`, (see: [Specify custom indentation prefix](#specify-custom-indentation-prefix))
 920 | - `defaults.link_prefix`, (see: [Link Prefix](#link-prefix))
 921 | - `defaults.levels`, (see: [Control of levels listed in TOC](#control-of-levels-listed-in-toc))
 922 | - `defaults.bullets`, (see: [Customizable list bullets in TOC](#customizable-list-bullets-in-toc))
 923 | - `defaults.lowercase`, (see: [Lowercasing in ids](#lowercasing-in-ids))
 924 | - `defaults.remove_image`, (see: [Preserve images in headings](#maintain-the-images-in-headings))
 925 | - `defaults.style`, (see: [Ordered or unordered style for TOC elements](#ordered-or-unordered-style-for-toc-elements))
 926 | - `defaults.uri_encoding`, (see: [URI encoding](#uri-encoding))
 927 | - `defaults.markdown_preview`, (see: [Markdown Preview compatible](#markdown-preview-compatible))
 928 | - `id_replacements`, (see: [Manipulation of auto link ids](#manipulation-of-auto-link-ids))
 929 | 
 930 | ### Github Configuration
 931 | 
 932 | A configuration for writing Markdown primaily for use on [Github] _could_ look like the following:
 933 | 
 934 | ```json
 935 | {
 936 |   "defaults": {
 937 |     "autolink": true,
 938 |     "bracket": "round",
 939 |     "lowercase": "only_ascii"
 940 |   }
 941 | }
 942 | ```
 943 | 
 944 | ### Configuration and Collaboration
 945 | 
 946 | You should be aware that if you collaborate with other [Markdown] writers and users of **MarkdownTOC**, you might have changes going back and forth simply due to differing configurations.
 947 | 
 948 | If that is the case and you cannot agree on a configuration, choose configuration using attributes specified in the document instead.
 949 | 
 950 | Example of attribute configuration for the above configuration settings in file:
 951 | 
 952 | ```markdown
 953 | <!-- MarkdownTOC autolink="true" bracket="round" autoanchor="true" -->
 954 | ```
 955 | 
 956 | ## Compatibility
 957 | 
 958 | This is by no means an exhaustive list and you are welcome to provide additional information and feedback. Here is listed what Markdown rendering platforms and tools where compatibility and incompatibily has been asserted with the **MarkdownTOC** plugin.
 959 | 
 960 | | Application  | Compatibility |
 961 | | ------------ | ------------- |
 962 | | [Github](https://github.com/) | Compatible |
 963 | | [Gitblit](http://gitblit.com/) 1.6.x | Incompatible |
 964 | | [Gitlab](https://about.gitlab.com/) 8.10.x | Compatible |
 965 | | [BitBucket](https://bitbucket.org/) 5.12.2 | Incompatible |
 966 | 
 967 | ## Contributing
 968 | 
 969 | Contributions are most welcome, please see the [guidelines on contributing](https://github.com/naokazuterada/MarkdownTOC/blob/master/.github/CONTRIBUTING.md).
 970 | 
 971 | ## License
 972 | 
 973 | - **MarkdownTOC** is licensed under the [MIT License](https://github.com/naokazuterada/MarkdownTOC/blob/master/LICENSE-MIT)
 974 | 
 975 | ## Author
 976 | 
 977 | - [Naokazu Terada](https://github.com/naokazuterada)
 978 | 
 979 | ## References
 980 | 
 981 | - [Daring Fireballs Markdown Syntax Specification][Markdown]
 982 | - [Sublime Text][SublimeText]
 983 | - [Sublime Text: Package Control][PackageControl]
 984 | - [Emoji cheatsheet][emoji]
 985 | - [GitHub Flavored Markdown][Github]
 986 | - [Markdown Preview][MarkdownPreview]
 987 | 
 988 | ### Markdown Table of Contents Generators
 989 | 
 990 | Here follows a list of other Markdown Table of Contents generators, for inspiration and perhaps even use in the situation where the **MarkdownTOC** Sublime Text plugin is _not the right tool for the job_. Please note that the list is by no means authoritative or exhaustive and is not a list of recommendations, since we can only endorse **MarkdownTOC** our contribution to the Markdown Table of Content generators toolbox.
 991 | 
 992 | - [doctoc](https://github.com/thlorenz/doctoc) Node (npm) implementation with CLI interface
 993 | - [markdown-toclify](https://github.com/rasbt/markdown-toclify) Python implementation with CLI interface
 994 | 
 995 | ### Recommended plugins for use with MarkdownTOC
 996 | 
 997 | - [Markdown Numbered Headers](https://packagecontrol.io/packages/Markdown%20Numbered%20Headers) Sublime Text 3 plugin for Markdown, auto insert/update/remove header numbers
 998 | 
 999 | [Markdown]: http://daringfireball.net/projects/markdown/syntax
1000 | [MarkdownLinks]: http://daringfireball.net/projects/markdown/syntax#link
1001 | [SublimeText]: http://www.sublimetext.com/
1002 | [SublimeTextSettings]: https://docs.sublimetext.info/en/latest/customization/settings.html
1003 | [PackageControl]: http://wbond.net/sublime_packages/package_control
1004 | [emoji]: http://www.emoji-cheat-sheet.com/
1005 | [Github]: https://help.github.com/articles/basic-writing-and-formatting-syntax/
1006 | [MarkdownPreview]: https://packagecontrol.io/packages/Markdown%20Preview
1007 | 


--------------------------------------------------------------------------------
/Vagrantfile:
--------------------------------------------------------------------------------
 1 | # Your package name
 2 | PACKAGE = "UnitTesting-example"
 3 | 
 4 | # Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
 5 | VAGRANTFILE_API_VERSION = "2"
 6 | 
 7 | $script = <<SCRIPT
 8 | export SUBLIME_TEXT_VERSION=$1
 9 | export PACKAGE="$2"
10 | wget -O /home/vagrant/vagrant.sh https://raw.githubusercontent.com/randy3k/UnitTesting/master/sbin/vagrant.sh
11 | chmod +x /home/vagrant/vagrant.sh
12 | /home/vagrant/vagrant.sh provision
13 | SCRIPT
14 | 
15 | Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
16 |     config.vm.box = "precise64"
17 |     config.vm.box_url = "http://files.vagrantup.com/precise64.box"
18 | 
19 |     config.vm.define "st3" do |st3|
20 |         st3.vm.provision "shell" do |s|
21 |             s.inline = $script
22 |             s.args = ["3", PACKAGE]
23 |         end
24 |     end
25 | end
26 | 


--------------------------------------------------------------------------------
/__init__.py:
--------------------------------------------------------------------------------
1 | from .markdowntoc.autorunner import AutoRunner
2 | from .markdowntoc.markdowntoc_insert import MarkdowntocInsert
3 | from .markdowntoc.markdowntoc_update import MarkdowntocUpdate
4 | 


--------------------------------------------------------------------------------
/appveyor.yml:
--------------------------------------------------------------------------------
 1 | environment:
 2 |     # The package name
 3 |     PACKAGE: "MarkdownTOC"
 4 |     SUBLIME_TEXT_VERSION : "3"
 5 | 
 6 | install:
 7 |     - ps: appveyor DownloadFile "https://raw.githubusercontent.com/SublimeText/UnitTesting/master/sbin/appveyor.ps1"
 8 |     - ps: .\appveyor.ps1 "bootstrap" -verbose
 9 |     # install Package Control
10 |     # - ps: .\appveyor.ps1 "install_package_control" -verbose
11 | 
12 | build: off
13 | 
14 | test_script:
15 | 
16 |     # run tests with test coverage report
17 |     - ps: .\appveyor.ps1 "run_tests" -coverage -verbose
18 | 
19 | on_finish:
20 |     - "SET PYTHON=C:\\Python33"
21 |     - "SET PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%"
22 |     - pip install codecov
23 |     - codecov


--------------------------------------------------------------------------------
/images/capture.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/naokazuterada/MarkdownTOC/b61546d001661d9385423556a62c21c36abc6857/images/capture.gif


--------------------------------------------------------------------------------
/images/how_to_remove_the_toc.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/naokazuterada/MarkdownTOC/b61546d001661d9385423556a62c21c36abc6857/images/how_to_remove_the_toc.gif


--------------------------------------------------------------------------------
/images/title.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/naokazuterada/MarkdownTOC/b61546d001661d9385423556a62c21c36abc6857/images/title.gif


--------------------------------------------------------------------------------
/markdowntoc/__init__.py:
--------------------------------------------------------------------------------
1 | from .autorunner import AutoRunner
2 | from .markdowntoc_insert import MarkdowntocInsert
3 | from .markdowntoc_update import MarkdowntocUpdate
4 | 
5 | __all__ = ["AutoRunner", "MarkdowntocInsert", "MarkdowntocUpdate"]
6 | 


--------------------------------------------------------------------------------
/markdowntoc/autorunner.py:
--------------------------------------------------------------------------------
 1 | import os.path
 2 | import sublime_plugin
 3 | 
 4 | 
 5 | class AutoRunner(sublime_plugin.EventListener):
 6 |     def on_pre_save(self, view):
 7 |         # limit scope
 8 |         root, ext = os.path.splitext(view.file_name())
 9 |         ext = ext.lower()
10 |         if ext in [".md", ".markdown", ".mdown", ".mdwn", ".mkdn", ".mkd", ".mark", ".mdx"]:
11 |             view.run_command("markdowntoc_update")
12 | 


--------------------------------------------------------------------------------
/markdowntoc/base.py:
--------------------------------------------------------------------------------
 1 | import pprint
 2 | import sublime
 3 | from .util import Util
 4 | 
 5 | # for debug
 6 | pp = pprint.PrettyPrinter(indent=4)
 7 | 
 8 | 
 9 | class Base(object):
10 |     def settings(self, attr):
11 |         DEFAULT = "Packages/MarkdownTOC/MarkdownTOC.sublime-settings"
12 |         files = sublime.find_resources("MarkdownTOC.sublime-settings")
13 |         files.remove(DEFAULT)
14 | 
15 |         settings = self.decode_value(DEFAULT)
16 |         for f in files:
17 |             user_settings = self.decode_value(f)
18 |             if user_settings != None:
19 |                 Util.dict_merge(settings, user_settings)
20 |         return settings[attr]
21 | 
22 |     def defaults(self):
23 |         return self.settings("defaults")
24 | 
25 |     def decode_value(self, file):
26 |         # Check json syntax
27 |         try:
28 |             return sublime.decode_value(sublime.load_resource(file))
29 |         except ValueError as e:
30 |             self.error("Invalid json in %s: %s" % (file, e))
31 | 
32 |     def log(self, arg):
33 |         if self.settings("logging") is True:
34 |             arg = str(arg)
35 |             sublime.status_message(arg)
36 |             pp.pprint(arg)
37 | 
38 |     def error(self, arg):
39 |         arg = "MarkdownTOC Error: " + arg
40 |         arg = str(arg)
41 |         sublime.status_message(arg)
42 |         pp.pprint(arg)
43 | 


--------------------------------------------------------------------------------
/markdowntoc/id.py:
--------------------------------------------------------------------------------
  1 | import re
  2 | import unicodedata
  3 | from urllib.parse import quote
  4 | 
  5 | from .base import Base
  6 | 
  7 | 
  8 | class Id(Base):
  9 |     def __init__(self, id_replacements, markdown_preview, lowercase):
 10 |         super().__init__()
 11 |         self.id_replacements = id_replacements
 12 |         self.markdown_preview = markdown_preview
 13 |         self.lowercase = lowercase
 14 | 
 15 |     def heading_to_id(self, heading):
 16 |         if heading is None:
 17 |             return ""
 18 |         if self.markdown_preview == "github":
 19 |             _h1 = self.postprocess_inject_header_id("<h1>%s</h1>" % heading)
 20 |             pattern = r'<h1 id="(.*)">.*</h1>'
 21 |             matches = re.finditer(pattern, _h1)
 22 |             for match in matches:
 23 |                 return match.groups()[0]
 24 |         elif self.markdown_preview == "markdown":
 25 |             return self.slugify(heading, "-")
 26 |         else:
 27 |             if self.lowercase == "false":
 28 |                 _id = heading
 29 |             elif self.lowercase == "only_ascii":
 30 |                 _id = "".join(chr(ord(x) + ("A" <= x <= "Z") * 32) for x in heading)
 31 |             else:
 32 |                 _id = heading.lower()
 33 |             return self.do_id_replacements(_id)
 34 | 
 35 |     def do_id_replacements(self, _str):
 36 | 
 37 |         # **Ignore the texts in codeblocks
 38 |         # **[1] stock and take over codeblocks
 39 |         matches = re.finditer(r"`([^`]*)`", _str)
 40 |         _str = re.sub(r"`([^`]*)`", "[codeblock]", _str)
 41 | 
 42 |         # Treat '_' for italic and '_' as text
 43 |         _str = re.sub(
 44 |             r"( |^)([\*|_]{1,3})([^\*|_\s]+|[^\*|_\s].*[^\*|_\s])\2( |$)",
 45 |             "\\1\\3\\4",
 46 |             _str,
 47 |         )
 48 | 
 49 |         # **[2] recover codeblocks
 50 |         for match in matches:
 51 |             _str = _str.replace("[codeblock]", match.groups()[0], 1)
 52 | 
 53 |         # User setting replacements
 54 |         for group in self.id_replacements:
 55 |             _str = re.sub(group["pattern"], group["replacement"], _str)
 56 |         return _str
 57 | 
 58 |     # from MarkdownPreview
 59 |     def slugify(self, value, separator):
 60 |         """ Slugify a string, to make it URL friendly. """
 61 |         value = unicodedata.normalize("NFKD", value).encode("ascii", "ignore")
 62 |         value = re.sub("[^\w\s-]", "", value.decode("ascii")).strip().lower()
 63 |         return re.sub("[%s\s]+" % separator, separator, value)
 64 | 
 65 |     # from MarkdownPreview
 66 |     def postprocess_inject_header_id(self, html):
 67 |         """ Insert header ids when no anchors are present """
 68 |         unique = {}
 69 | 
 70 |         def header_to_id(text):
 71 |             if text is None:
 72 |                 return ""
 73 |             # Strip html tags and lower
 74 |             id = RE_TAGS.sub("", text).lower()
 75 |             # Remove non word characters or non spaces and dashes
 76 |             # Then convert spaces to dashes
 77 |             id = RE_WORD.sub("", id).replace(" ", "-")
 78 |             # Encode anything that needs to be
 79 |             return quote(id)
 80 | 
 81 |         def inject_id(m):
 82 |             id = header_to_id(m.group("text"))
 83 |             if id == "":
 84 |                 return m.group(0)
 85 |             # Append a dash and number for uniqueness if needed
 86 |             value = unique.get(id, None)
 87 |             if value is None:
 88 |                 unique[id] = 1
 89 |             else:
 90 |                 unique[id] += 1
 91 |                 id += "-%d" % value
 92 |             return (
 93 |                 m.group("open")[:-1]
 94 |                 + (' id="%s">' % id)
 95 |                 + m.group("text")
 96 |                 + m.group("close")
 97 |             )
 98 | 
 99 |         RE_TAGS = re.compile(r"""</?[^>]*>""")
100 |         RE_WORD = re.compile(r"""[^\w\- ]""")
101 |         RE_HEADER = re.compile(
102 |             r"""(?P<open><h([1-6])>)(?P<text>.*?)(?P<close></h\2>)""", re.DOTALL
103 |         )
104 | 
105 |         return RE_HEADER.sub(inject_id, html)
106 | 


--------------------------------------------------------------------------------
/markdowntoc/markdowntoc_insert.py:
--------------------------------------------------------------------------------
  1 | import pprint
  2 | import re
  3 | import sublime
  4 | import sublime_plugin
  5 | import sys
  6 | import webbrowser
  7 | 
  8 | from urllib.parse import quote
  9 | 
 10 | from .autorunner import AutoRunner
 11 | from .base import Base
 12 | from .util import Util
 13 | from .id import Id
 14 | 
 15 | # for debug
 16 | pp = pprint.PrettyPrinter(indent=4)
 17 | 
 18 | # [Heading][my-id]
 19 | # Negative lookbehind
 20 | PT_REF_LINK = re.compile(r"(?<!\\)\[.+?(?<!\\)\]\s*$")
 21 | 
 22 | # ![alt](path/to/image.png)
 23 | PT_IMAGE = re.compile(r"!\[([^\]]+)\]\([^\)]+\)")
 24 | # [Heading]{#my-id}
 25 | PT_EX_ID = re.compile(r"\{#.+?\}$")
 26 | PT_TAG = re.compile(r"<.*?>")
 27 | PT_ANCHOR = re.compile(r'<a\s+id="[^"]+"\s*>\s*</a>')
 28 | 
 29 | 
 30 | # <!-- MarkdownTOC:excluded  -->
 31 | PT_EXCLUDE = re.compile(r"^<!--.*(MarkdownTOC:excluded).*-->", re.IGNORECASE)
 32 | 
 33 | 
 34 | class MarkdowntocInsert(sublime_plugin.TextCommand, Base):
 35 |     def run(self, edit):
 36 |         if not self.find_tag_and_insert(edit):
 37 |             sels = self.view.sel()
 38 |             for sel in sels:
 39 |                 attrs = self.defaults()
 40 | 
 41 |                 # add TOCTAG
 42 |                 toc = "<!-- MarkdownTOC -->\n"
 43 |                 toc += "\n"
 44 |                 toc += self.get_toc(attrs, sel.end(), edit)
 45 |                 toc += "\n"
 46 |                 toc += "<!-- /MarkdownTOC -->\n"
 47 | 
 48 |                 self.view.insert(edit, sel.begin(), toc)
 49 |                 self.log("inserted TOC")
 50 | 
 51 |         # TODO: process to add another toc when tag exists
 52 | 
 53 |     def get_toc_open_tag(self):
 54 |         search_results = self.view.find_all(
 55 |             r"^<!--[\s\n]+MarkdownTOC[\s\n]+[^>]*-->\n", sublime.IGNORECASE
 56 |         )
 57 |         search_results = self.remove_items_in_codeblock(search_results)
 58 | 
 59 |         toc_open_tags = []
 60 |         for toc_open in search_results:
 61 |             if 0 < len(toc_open):
 62 | 
 63 |                 toc_open_tag = {"region": toc_open}
 64 | 
 65 |                 # settings in user settings
 66 |                 settings_user = self.defaults()
 67 | 
 68 |                 # settings in tag
 69 |                 tag_str = self.view.substr(toc_open)
 70 |                 settings_tag = self.get_attributes_from(tag_str)
 71 | 
 72 |                 # merge
 73 |                 toc_open_tag.update(settings_user)
 74 |                 toc_open_tag.update(settings_tag)
 75 | 
 76 |                 toc_open_tags.append(toc_open_tag)
 77 | 
 78 |         return toc_open_tags
 79 | 
 80 |     def get_toc_close_tag(self, start):
 81 |         close_tags = self.view.find_all(r"<!--[\s\n]+/MarkdownTOC[\s\n]+-->\n")
 82 |         close_tags = self.remove_items_in_codeblock(close_tags)
 83 |         for close_tag in close_tags:
 84 |             if start < close_tag.begin():
 85 |                 return close_tag
 86 | 
 87 |     def find_tag_and_insert(self, edit):
 88 |         """Search MarkdownTOC comments in document"""
 89 |         toc_starts = self.get_toc_open_tag()
 90 |         for dic in toc_starts:
 91 | 
 92 |             toc_start = dic["region"]
 93 |             if 0 < len(toc_start):
 94 | 
 95 |                 toc_close = self.get_toc_close_tag(toc_start.end())
 96 | 
 97 |                 if toc_close:
 98 |                     toc = self.get_toc(dic, toc_close.end(), edit)
 99 |                     tocRegion = sublime.Region(toc_start.end(), toc_close.begin())
100 |                     if toc:
101 |                         self.view.replace(edit, tocRegion, "\n" + toc + "\n")
102 |                         self.log("refresh TOC content")
103 |                         return True
104 |                     else:
105 |                         self.view.replace(edit, tocRegion, "\n")
106 |                         self.log("TOC is empty")
107 |                         return False
108 |         self.log("cannot find TOC tags")
109 |         return False
110 | 
111 |     def escape_brackets(self, _text):
112 |         # Escape brackets which not in image and codeblock
113 | 
114 |         def do_escape(_text, _pattern, _open, _close):
115 |             images = []
116 |             brackets = []
117 |             codes = []
118 |             for m in re.compile(r"`[^`]*`").finditer(_text):
119 |                 codes.append([m.start(), m.end()])
120 | 
121 |             def not_in_codeblock(target):
122 |                 return not Util.within_ranges(target, codes)
123 | 
124 |             def not_in_image(target):
125 |                 return not Util.within_ranges(target, images)
126 | 
127 |             # Collect images not in codeblock
128 |             for m in PT_IMAGE.finditer(_text):
129 |                 images.append([m.start(), m.end()])
130 |             images = list(filter(not_in_codeblock, images))
131 |             # Collect brackets not in image tags
132 |             for m in _pattern.finditer(_text):
133 |                 brackets.append([m.start(), m.end()])
134 |             brackets = list(filter(not_in_image, brackets))
135 |             brackets = list(filter(not_in_codeblock, brackets))
136 |             brackets = list(map((lambda x: x[0]), brackets))
137 |             # Escape brackets
138 | 
139 |             def replace_brackets(m):
140 |                 if m.start() in brackets:
141 |                     return _open + m.group(1) + _close
142 |                 else:
143 |                     return m.group(0)
144 | 
145 |             return re.sub(_pattern, replace_brackets, _text)
146 | 
147 |         _text = do_escape(_text, re.compile(r"(?<!\\)\[([^\]]*)(?<!\\)\]"), "\[", "\]")
148 |         _text = do_escape(_text, re.compile(r"(?<!\\)\(([^\)]*)(?<!\\)\)"), "\(", "\)")
149 | 
150 |         return _text
151 | 
152 |     # TODO: add "end" parameter
153 |     def get_toc(self, attrs, begin, edit):
154 | 
155 |         # Search headings in docment
156 |         pattern_hash = "^#+?[^#]"
157 |         pattern_h1_h2_equal_dash = "^.*?(?:(?:\r\n)|\n|\r)(?:-+|=+)$"
158 |         pattern_heading = "%s|%s" % (pattern_h1_h2_equal_dash, pattern_hash)
159 |         headings = self.view.find_all(pattern_heading)
160 | 
161 |         headings = self.remove_items_in_codeblock(headings)
162 | 
163 |         if len(headings) < 1:
164 |             return ""
165 | 
166 |         items = []  # [[headingNum, text, position, anchor_id], ...]
167 |         for heading in headings:
168 |             if begin < heading.end():
169 |                 lines = self.view.lines(heading)
170 |                 previous_line = self.view.substr(self.view.line(lines[0].a - 1))
171 |                 if PT_EXCLUDE.match(previous_line):
172 |                     continue
173 | 
174 |                 if len(lines) == 1:
175 |                     # handle hash headings, ### chapter 1
176 |                     r = sublime.Region(heading.end() - 1, self.view.line(heading).end())
177 |                     text = self.view.substr(r).strip().rstrip("#")
178 |                     indent = heading.size() - 1
179 |                     items.append([indent, text, heading.begin()])
180 |                 elif len(lines) == 2:
181 |                     # handle = or - headings
182 |                     # Title 1
183 |                     # ====
184 |                     # section1
185 |                     # ----
186 |                     text = self.view.substr(lines[0])
187 |                     if text.strip():
188 |                         heading_type = self.view.substr(lines[1])[0]
189 |                         indent = 1 if heading_type == "=" else 2
190 |                         items.append([indent, text, heading.begin()])
191 | 
192 |         if len(items) < 1:
193 |             return ""
194 | 
195 |         # Filtering by heading level  ------------------
196 |         accepted_levels = list(map(lambda i: int(i), attrs["levels"]))
197 |         items = list(filter((lambda j: j[0] in accepted_levels), items))
198 | 
199 |         # Shape TOC  ------------------
200 |         items = Util.format(items)
201 | 
202 |         # TODO: Remove this block in the future release version
203 |         # Depth limit  ------------------
204 |         if hasattr(attrs, "depth"):
205 |             # WARNING
206 |             url = "https://github.com/naokazuterada/MarkdownTOC/releases/tag/3.0.0"
207 |             message = "[MarkdownTOC] <b>OBSOLETE</b> <br>Don't use 'depth' any more, use 'levels' instead."
208 | 
209 |             def open_link(v):
210 |                 webbrowser.open_new(url)
211 | 
212 |             self.view.show_popup(
213 |                 message + "<br><a href>Instruction</a>", on_navigate=open_link
214 |             )
215 |             self.error(PT_TAG.sub("", message) + " Instruction > " + url)
216 | 
217 |         # Create TOC  ------------------
218 |         toc = ""
219 |         _ids = []
220 |         level_counters = [0]
221 |         remove_image = attrs["remove_image"]
222 |         link_prefix = attrs["link_prefix"]
223 |         bullets = attrs["bullets"]
224 | 
225 |         for item in items:
226 |             _id = None
227 |             _indent = item[0] - 1
228 |             _text = item[1]
229 |             if remove_image:
230 |                 # Remove markdown image which not in codeblock
231 |                 images = []
232 |                 codes = []
233 |                 for m in re.compile(r"`[^`]*`").finditer(_text):
234 |                     codes.append([m.start(), m.end()])
235 | 
236 |                 def not_in_codeblock(_target):
237 |                     return not Util.within_ranges(_target, codes)
238 | 
239 |                 # Collect images not in codeblock
240 |                 for m in PT_IMAGE.finditer(_text):
241 |                     images.append([m.start(), m.end()])
242 |                 images = list(filter(not_in_codeblock, images))
243 |                 images = list(map((lambda x: x[0]), images))
244 | 
245 |                 def _replace(m):
246 |                     if m.start() in images:
247 |                         return ""
248 |                     else:
249 |                         return m.group(0)
250 | 
251 |                 _text = re.sub(PT_IMAGE, _replace, _text)
252 | 
253 |             _list_bullet = bullets[_indent % len(bullets)]
254 |             _text = PT_TAG.sub("", _text)  # remove html tags
255 |             _text = _text.strip()  # remove start and end spaces
256 | 
257 |             # Ignore links: e.g. '[link](http://sample.com/)' -> 'link'
258 |             # this is [link](http://www.sample.com/)
259 |             link = re.compile(r"([^!])\[([^\]]+)\]\([^\)]+\)")
260 |             _text = link.sub("\\1\\2", _text)
261 |             # [link](http://www.sample.com/) link in the beginning of line
262 |             beginning_link = re.compile(r"^\[([^\]]+)\]\([^\)]+\)")
263 |             _text = beginning_link.sub("\\1", _text)
264 | 
265 |             # Add indent
266 |             for i in range(_indent):
267 |                 _prefix = attrs["indent"]
268 |                 # Support escaped characters like '\t'
269 |                 _prefix = _prefix.encode().decode("unicode-escape")
270 |                 toc += _prefix
271 | 
272 |             # -----------------
273 |             # Reference-style links: e.g. '# heading [my-anchor]'
274 |             ref_links = list(PT_REF_LINK.finditer(_text))
275 | 
276 |             def filtering(ref_links, text):
277 |                 images = []
278 |                 codes = []
279 |                 valids = []
280 |                 for m in re.compile(r"`[^`]*`").finditer(text):
281 |                     codes.append([m.start(), m.end()])
282 | 
283 |                 def not_in_codeblock(target):
284 |                     return not Util.within_ranges(target, codes)
285 | 
286 |                 def not_in_image(target):
287 |                     return not Util.within_ranges(target, images)
288 | 
289 |                 # Collect images not in codeblock
290 |                 for m in PT_IMAGE.finditer(text):
291 |                     images.append([m.start(), m.end()])
292 |                 images = list(filter(not_in_codeblock, images))
293 |                 # # Collect valids not in image tags
294 |                 for m in ref_links:
295 |                     valids.append([m.start(), m.end()])
296 |                 valids = list(filter(not_in_image, valids))
297 |                 valids = list(filter(not_in_codeblock, valids))
298 |                 valids = list(map((lambda x: x[0]), valids))
299 |                 return list(filter(lambda x: x.start() in valids, ref_links))
300 | 
301 |             ref_links = filtering(ref_links, _text)
302 | 
303 |             # -----------------
304 | 
305 |             # Markdown-Extra special attribute style:
306 |             # e.g. '# heading {#my-anchor}'
307 |             match_ex_id = PT_EX_ID.search(_text)
308 | 
309 |             if len(ref_links):
310 |                 match = ref_links[-1]
311 |                 _text = (
312 |                     _text[0 : match.start()].replace("[", "").replace("]", "").rstrip()
313 |                 )
314 |                 _id = match.group().replace("[", "").replace("]", "")
315 |             elif match_ex_id:
316 |                 _text = _text[0 : match_ex_id.start()].rstrip()
317 |                 _id = match_ex_id.group().replace("{#", "").replace("}", "")
318 |             elif attrs["autolink"]:
319 |                 _id = Id(
320 |                     self.settings("id_replacements"),
321 |                     attrs["markdown_preview"],
322 |                     str(attrs["lowercase"]).lower(),
323 |                 ).heading_to_id(_text)
324 |                 if attrs["uri_encoding"]:
325 |                     _id = quote(_id)
326 | 
327 |                 _ids.append(_id)
328 |                 n = _ids.count(_id)
329 |                 if 1 < n:
330 |                     delimiter = "_" if attrs["markdown_preview"] == "markdown" else "-"
331 |                     _id += delimiter + str(n - 1)
332 | 
333 |             if attrs["style"] == "unordered":
334 |                 list_prefix = _list_bullet + " "
335 |             elif attrs["style"] == "ordered":
336 |                 list_prefix = "1. "
337 | 
338 |             # escape brackets
339 |             _text = self.escape_brackets(_text)
340 | 
341 |             if link_prefix:
342 |                 _id = link_prefix + _id
343 | 
344 |             if _id is None:
345 |                 toc += list_prefix + _text + "\n"
346 |             elif attrs["bracket"] == "round":
347 |                 toc += list_prefix + "[" + _text + "](#" + _id + ")\n"
348 |             else:
349 |                 toc += list_prefix + "[" + _text + "][" + _id + "]\n"
350 | 
351 |             item.append(_id)
352 | 
353 |         self.update_anchors(edit, items, attrs["autoanchor"])
354 | 
355 |         return toc
356 | 
357 |     def update_anchors(self, edit, items, autoanchor):
358 |         """Inserts, updates or deletes a link anchor in the line before each header."""
359 |         v = self.view
360 |         # Iterate in reverse so that inserts don't affect the position
361 |         for item in reversed(items):
362 |             anchor_region = v.line(item[2] - 1)  # -1 to get to previous line
363 |             is_update = PT_ANCHOR.match(v.substr(anchor_region))
364 |             if autoanchor:
365 |                 # if autolink=false then item[3] will be None,
366 |                 # so use raw heading valie(replaced whitespaces) then
367 |                 _id = item[3] or re.sub(r"\s+", "-", item[1])
368 |                 if is_update:
369 |                     new_anchor = '<a id="{0}"></a>'.format(_id)
370 |                     v.replace(edit, anchor_region, new_anchor)
371 |                 else:
372 |                     new_anchor = '\n<a id="{0}"></a>'.format(_id)
373 |                     v.insert(edit, anchor_region.end(), new_anchor)
374 | 
375 |             else:
376 |                 if is_update:
377 |                     v.erase(
378 |                         edit,
379 |                         sublime.Region(anchor_region.begin(), anchor_region.end() + 1),
380 |                     )
381 | 
382 |     def get_attributes_from(self, tag_str):
383 |         """return dict of settings from tag_str"""
384 |         pattern = re.compile(
385 |             r'\b(?P<name>\w+)=((?P<empty>)|(\'(?P<quoted>[^\']+)\')|("(?P<dquoted>[^"]+)")|(?P<simple>\S+))\s'
386 |         )
387 |         attrs = dict(
388 |             (
389 |                 m.group("name"),
390 |                 m.group("simple")
391 |                 or m.group("dquoted")
392 |                 or m.group("quoted")
393 |                 or m.group("empty"),
394 |             )
395 |             for m in pattern.finditer(tag_str)
396 |         )
397 | 
398 |         # parse values according to type of values in settings file
399 |         defaults = self.defaults()
400 |         for key in attrs:
401 |             if type(defaults[key]) is list:
402 |                 attrs[key] = attrs[key].split(",")
403 |             elif type(defaults[key]) is bool:
404 |                 attrs[key] = Util.strtobool(attrs[key])
405 | 
406 |         return attrs
407 | 
408 |     def remove_items_in_codeblock(self, items):
409 | 
410 |         codeblocks = self.view.find_all("^\s*(`{3,}|~{3,})\S*")
411 |         codeblockAreas = []  # [[area_begin, area_end], ..]
412 |         i = 0
413 |         while i < len(codeblocks) - 1:
414 |             area_begin = codeblocks[i].begin()
415 |             area_end = codeblocks[i + 1].begin()
416 |             if area_begin and area_end:
417 |                 codeblockAreas.append([area_begin, area_end])
418 |             i += 2
419 | 
420 |         items = [h for h in items if Util.is_out_of_areas(h.begin(), codeblockAreas)]
421 |         return items
422 | 


--------------------------------------------------------------------------------
/markdowntoc/markdowntoc_update.py:
--------------------------------------------------------------------------------
1 | from .markdowntoc_insert import MarkdowntocInsert
2 | 
3 | 
4 | class MarkdowntocUpdate(MarkdowntocInsert):
5 |     def run(self, edit):
6 |         MarkdowntocInsert.find_tag_and_insert(self, edit)
7 | 


--------------------------------------------------------------------------------
/markdowntoc/util.py:
--------------------------------------------------------------------------------
 1 | import collections
 2 | 
 3 | 
 4 | class Util:
 5 |     def is_out_of_areas(num, areas):
 6 |         for area in areas:
 7 |             if area[0] < num and num < area[1]:
 8 |                 return False
 9 |         return True
10 | 
11 |     def format(items):
12 |         levels = []
13 |         for item in items:
14 |             levels.append(item[0])
15 |         # --------------------------
16 | 
17 |         # minimize diff between levels -----
18 |         _depths = list(set(levels))  # sort and unique
19 |         # replace with depth rank
20 |         for i, item in enumerate(levels):
21 |             levels[i] = _depths.index(levels[i]) + 1
22 | 
23 |         # Force set level of first item to 1 -----
24 |         # (first item must be list root)
25 |         if len(levels):
26 |             diff_to_root = levels[0] - 1
27 |             if 0 < diff_to_root:
28 | 
29 |                 def pad(level):
30 |                     return level - diff_to_root
31 | 
32 |                 levels = list(map(pad, levels))
33 | 
34 |         # --------------------------
35 |         for i, item in enumerate(items):
36 |             item[0] = levels[i]
37 |         return items
38 | 
39 |     def strtobool(val):
40 |         """pick out from 'distutils.util' module"""
41 |         if isinstance(val, str):
42 |             val = val.lower()
43 |             if val in ("y", "yes", "t", "true", "on", "1"):
44 |                 return 1
45 |             elif val in ("n", "no", "f", "false", "off", "0"):
46 |                 return 0
47 |             else:
48 |                 raise ValueError("invalid truth value %r" % (val,))
49 |         else:
50 |             return bool(val)
51 | 
52 |     def within_ranges(target, ranges):
53 |         tb = target[0]
54 |         te = target[1]
55 |         for _range in ranges:
56 |             rb = _range[0]
57 |             re = _range[1]
58 |             if (rb <= tb and tb <= re) and (rb <= tb and tb <= re):
59 |                 return True
60 |         return False
61 | 
62 |     # This method is from https://gist.github.com/angstwad/bf22d1822c38a92ec0a9
63 |     def dict_merge(dct, merge_dct):
64 |         """ Recursive dict merge. Inspired by :meth:``dict.update()``, instead of
65 |         updating only top-level keys, dict_merge recurses down into dicts nested
66 |         to an arbitrary depth, updating keys. The ``merge_dct`` is merged into
67 |         ``dct``.
68 |         :param dct: dict onto which the merge is executed
69 |         :param merge_dct: dct merged into dct
70 |         :return: None
71 |         """
72 |         for k, v in merge_dct.items():
73 |             if (
74 |                 k in dct
75 |                 and isinstance(dct[k], dict)
76 |                 and isinstance(merge_dct[k], collections.Mapping)
77 |             ):
78 |                 Util.dict_merge(dct[k], merge_dct[k])
79 |             else:
80 |                 dct[k] = merge_dct[k]
81 | 


--------------------------------------------------------------------------------
/messages.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "install": "messages/install.md",
 3 |   "1.2.1": "messages/1.2.1.md",
 4 |   "1.3.0": "messages/1.3.0.md",
 5 |   "1.4.0": "messages/1.4.0.md",
 6 |   "1.5.0": "messages/1.5.0.md",
 7 |   "1.6.0": "messages/1.6.0.md",
 8 |   "1.7.0": "messages/1.7.0.md",
 9 |   "1.8.0": "messages/1.8.0.md",
10 |   "2.0.0": "messages/2.0.0.md",
11 |   "2.2.0": "messages/2.2.0.md",
12 |   "2.2.1": "messages/2.2.1.md",
13 |   "2.3.0": "messages/2.3.0.md",
14 |   "2.3.1": "messages/2.3.1.md",
15 |   "2.3.2": "messages/2.3.2.md",
16 |   "2.4.0": "messages/2.4.0.md",
17 |   "2.4.1": "messages/2.4.1.md",
18 |   "2.5.0": "messages/2.5.0.md",
19 |   "2.6.0": "messages/2.6.0.md",
20 |   "2.7.0": "messages/2.7.0.md",
21 |   "2.7.1": "messages/2.7.1.md",
22 |   "2.7.2": "messages/2.7.2.md",
23 |   "2.7.3": "messages/2.7.3.md",
24 |   "3.0.0": "messages/3.0.0.md",
25 |   "3.0.1": "messages/3.0.1.md",
26 |   "3.0.2": "messages/3.0.2.md",
27 |   "3.0.3": "messages/3.0.3.md",
28 |   "3.0.4": "messages/3.0.4.md",
29 |   "3.0.5": "messages/3.0.5.md",
30 |   "4.0.0": "messages/4.0.0.md",
31 |   "4.0.1": "messages/4.0.1.md",
32 |   "4.0.2": "messages/4.0.2.md",
33 |   "4.1.0": "messages/4.1.0.md",
34 |   "4.1.1": "messages/4.1.1.md",
35 |   "4.1.2": "messages/4.1.2.md"
36 | }


--------------------------------------------------------------------------------
/messages/1.2.1.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 1.2.1
2 | 
3 | ## Changes
4 | 
5 | - Bug fixes


--------------------------------------------------------------------------------
/messages/1.3.0.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 1.3.0
 2 | 
 3 | ## Changes
 4 | 
 5 | - Add 'Auto link' feature
 6 | - Bug fix: ignore headings and toc tags in codeblock
 7 | - Remove auto rewrite toc tag when 'depth' attr is not declared
 8 | 
 9 | ---
10 | 
11 | More detail
12 | 
13 | https://github.com/naokazuterada/MarkdownTOC/


--------------------------------------------------------------------------------
/messages/1.4.0.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 1.4.0
 2 | 
 3 | ## Changes
 4 | 
 5 | - Change 'Auto link' syntax
 6 | - Implement defaults and override each TOCs
 7 | - Support MarkDown-Extra style to define ID
 8 | - Add 'Bracket' feature
 9 | - Bug fixes
10 |   - Dealing with reference link in heading
11 |   - Ignore links in heading
12 |   - Ignore spaces in the end of heading
13 | 
14 | # Notice 1
15 | 
16 | If you use 'auto-link' feature, you should rewrite TOC open tag.
17 | 
18 | ```
19 | <!-- MarkdownTOC autolink -->
20 | ```
21 | must to be...
22 | ```
23 | <!-- MarkdownTOC autolink=true -->
24 | ```
25 | 
26 | # Notice 2
27 | 
28 | Check 'Bracket' feature. You should change `default_bracket` in settings if you want TOC to be Github style.
29 | 
30 | 
31 | ---
32 | 
33 | More detail
34 | 
35 | https://github.com/naokazuterada/MarkdownTOC/


--------------------------------------------------------------------------------
/messages/1.5.0.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 1.5.0
 2 | 
 3 | ## Changes
 4 | 
 5 | - Add 'id_replacements' option in 'Package Settings'
 6 | 
 7 | 
 8 | # Notice
 9 | 
10 | You can also edit replecements when using 'Auto link' feature like following settings.
11 | 
12 | MarkdownTOC.sublime-settings
13 | 
14 | ```json
15 | {
16 |   "id_replacements": {
17 |     "-": " ",
18 |     "" : ["!","#","$","&","'","(",")","*","+",",","/",":",";","=","?","@","[","]","`","\"", ".","<",">","{","}","™","®","©"]
19 |   }
20 | }
21 | ```
22 | 
23 | - The value charactor(s) will be replaced to the key charactor.
24 | - Replece sequence will execute from top to bottom.
25 | 
26 | ---
27 | 
28 | More detail
29 | 
30 | https://github.com/naokazuterada/MarkdownTOC/


--------------------------------------------------------------------------------
/messages/1.6.0.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 1.6.0
 2 | 
 3 | ## Changes
 4 | 
 5 | - Add 'Auto anchor' feature
 6 | 
 7 | 
 8 | ## Notice
 9 | 
10 | You can add an HTML anchor (`<a name="xxx"></a>`) automaticaly before the heading.
11 | 
12 | ```
13 | <!-- MarkdownTOC autolink=true autoanchor=true brackets=round -->
14 | 
15 | - [Changelog](#changelog)
16 | - [Glossary](#glossary)
17 | - [API Specification](#api-specification)
18 | 
19 | <!-- /MarkdownTOC -->
20 | 
21 | <a name="changelog"></a>
22 | # Changelog
23 | Lorem ipsum...
24 | 
25 | <a name="glossary"></a>
26 | # Glossary
27 | Lorem ipsum...
28 | 
29 | <a name="api-specification"></a>
30 | # API Specification
31 | Lorem ipsum...
32 | ```
33 | 
34 | ---
35 | 
36 | More detail
37 | 
38 | https://github.com/naokazuterada/MarkdownTOC/


--------------------------------------------------------------------------------
/messages/1.7.0.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 1.7.0
 2 | 
 3 | ## Changes
 4 | 
 5 | - Add 'style' feature
 6 | 
 7 | 
 8 | You can control the type of list representing the TOC:
 9 | 
10 | ```
11 | <!-- MarkdownTOC style=unordered -->
12 | 
13 | - foo
14 |   - bar
15 |   - buz
16 | - qux
17 | 
18 | <!-- /MarkdownTOC -->
19 | ```
20 | ```
21 | <!-- MarkdownTOC style=ordered -->
22 | 
23 | 1. foo
24 |   1. bar
25 |     1. qux
26 |     2. quux
27 |   2. buz
28 | 2. qux
29 | 
30 | <!-- /MarkdownTOC -->
31 | ```
32 | 
33 | ---
34 | 
35 | More detail
36 | 
37 | https://github.com/naokazuterada/MarkdownTOC/


--------------------------------------------------------------------------------
/messages/1.8.0.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 1.8.0
 2 | 
 3 | ## Changes
 4 | 
 5 | - Enable to change indent prefix. ('Indent' feature)
 6 | 
 7 | 
 8 | You can set indent prefix.
 9 | 
10 | ```
11 | 4 spaces
12 | <!-- MarkdownTOC indent="    " -->
13 | 
14 | - foo
15 |     - bar
16 |         - buz
17 | 
18 | <!-- /MarkdownTOC -->
19 | ```


--------------------------------------------------------------------------------
/messages/2.0.0.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 2.0.0
 2 | 
 3 | ## Changes
 4 | 
 5 | - Enable HTML-like attribute style
 6 | - Remove compatibility to SublimeText2
 7 | 
 8 | 
 9 | Until 1.8.0, you have to write like below.
10 | 
11 | ```
12 | <!-- MarkdownTOC depth=5 -->
13 | <!-- /MarkdownTOC -->
14 | ```
15 | 
16 | Now you can write something like below.
17 | 
18 | ```
19 | <!-- MarkdownTOC depth=5 -->
20 | <!-- /MarkdownTOC -->
21 | 
22 | <!-- MarkdownTOC depth="5" -->
23 | <!-- /MarkdownTOC -->
24 | 
25 | <!-- MarkdownTOC depth='5' -->
26 | <!-- /MarkdownTOC -->
27 | ```


--------------------------------------------------------------------------------
/messages/2.1.0.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 2.1.0
 2 | 
 3 | ## Changes
 4 | 
 5 | - Add `lowercase_only_ascii` feature
 6 | 
 7 | 
 8 | The plugin lowercase all alphabets within auto link ids default.
 9 | 
10 | ```
11 | <!-- MarkdownTOC autolink=true -->
12 | 
13 | - [ПРИМЕР EXAMPLE][пример-example]
14 | 
15 | <!-- /MarkdownTOC -->
16 | 
17 | # ПРИМЕР EXAMPLE
18 | ```
19 | 
20 | But you can also squeeze its target **only ascii alphabets**(`a` to `z`) with `lowercase_only_ascii=true` attribute.
21 | 
22 | ```
23 | <!-- MarkdownTOC autolink=true lowercase_only_ascii=true -->
24 | 
25 | - [ПРИМЕР EXAMPLE][ПРИМЕР-example]
26 | 
27 | <!-- /MarkdownTOC -->
28 | 
29 | # ПРИМЕР EXAMPLE
30 | ```


--------------------------------------------------------------------------------
/messages/2.1.1.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 2.1.1
2 | 
3 | ## Changes
4 | 
5 | - Improved ATX headings
6 |     - Extra spaces processing in headings
7 |     - Removing of closing sequence of # characters
8 | - Allow not only chars but strings in id_replacement
9 | 


--------------------------------------------------------------------------------
/messages/2.1.2.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 2.1.2
2 | 
3 | ## Changes
4 | 
5 | - Fix anchoring problem with '_'
6 | 


--------------------------------------------------------------------------------
/messages/2.2.0.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 2.2.0
2 | 
3 | ## Changes
4 | 
5 | - Add 'logging' option in 'Package Settings'
6 | 
7 | ## Notice
8 | 
9 | If you are developper, please this option `true` to enable logging in console.


--------------------------------------------------------------------------------
/messages/2.2.1.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 2.2.1
2 | 
3 | ## Changes
4 | 
5 | - Improve heading detecting
6 | 


--------------------------------------------------------------------------------
/messages/2.3.0.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 2.3.0
2 | 
3 | ## Changes
4 | 
5 | - Add 'URI encoding' feature
6 | - Change 'default_lowercase_only_ascii' default value ('false' to 'true') because it breaks link in Russian
7 | 


--------------------------------------------------------------------------------
/messages/2.3.1.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 2.3.1
2 | 
3 | ## Changes
4 | 
5 | - Allow indentation of blockquates
6 | 


--------------------------------------------------------------------------------
/messages/2.3.2.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 2.3.2
2 | 
3 | ## Changes
4 | 
5 | - Fix the way of import dependencies
6 | - Add code coverage on README
7 | 


--------------------------------------------------------------------------------
/messages/2.4.0.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 2.4.0
2 | 
3 | ## Changes
4 | 
5 | - Support MarkdownPreview's anchoring
6 | 


--------------------------------------------------------------------------------
/messages/2.4.1.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 2.4.1
2 | 
3 | ## Changes
4 | 
5 | - Fix problem that user's settings doesn't work. Ref: #100
6 | - Fix problem that characters inside codeblock is also escaped. Ref: #64
7 |   Contribution by Mathieu PATUREL ( @math2001 ). Ref: #101
8 | 


--------------------------------------------------------------------------------
/messages/2.5.0.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 2.5.0
2 | 
3 | ## Changes
4 | 
5 | - Add `Customizable list bullets` feature
6 | 
7 | Ref: #41
8 | 


--------------------------------------------------------------------------------
/messages/2.6.0.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 2.6.0
2 | 
3 | ## Changes
4 | 
5 | - Add `remove_image` parameter. Ref: #43
6 | - Add `lowercase` parameter. Ref: #40
7 | 


--------------------------------------------------------------------------------
/messages/2.7.0.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 2.7.0
2 | 
3 | ## Changes
4 | 
5 | - Add `link_prefix` parameter. Ref: #54
6 | 


--------------------------------------------------------------------------------
/messages/2.7.1.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 2.7.1
 2 | 
 3 | ## Changes
 4 | 
 5 | - Drop BeautifulSoup dependency. Ref: #111
 6 |   Contribution by @ziembla
 7 | 
 8 | 
 9 | 
10 | 


--------------------------------------------------------------------------------
/messages/2.7.2.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 2.7.2
2 | 
3 | ## Changes
4 | 
5 | - Replace name attribute to id Ref: #116
6 | - Follow pycodestyle(pep8) lint rules
7 |   Contribution by @Kristinita
8 | 


--------------------------------------------------------------------------------
/messages/2.7.3.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 2.7.3
 2 | 
 3 | ## Changes
 4 | 
 5 | - Fix the preblem when using autoanchor without 'autolink=true'
 6 | 
 7 | ```
 8 | <!-- MarkdownTOC autolink=false autoanchor=true -->
 9 | 
10 | - Without autolink issue
11 | 
12 | <!-- /MarkdownTOC -->
13 | 
14 | 
15 | <a id="None"></a>
16 | # Without autolink issue
17 | ```
18 | 
19 | ↓
20 | 
21 | ```
22 | <!-- MarkdownTOC autolink=false autoanchor=true -->
23 | 
24 | - Without autolink issue
25 | 
26 | <!-- /MarkdownTOC -->
27 | 
28 | 
29 | <a id="Without-autolink-issue"></a>
30 | # Without autolink issue
31 | ```
32 | 
33 | #### Why replace whitespaces to '-'?
34 | 
35 | See this [specification](https://www.w3schools.com/tags/att_global_id.asp).
36 | 
37 | > Specifies a unique id for the element. Naming rules:
38 | >
39 | > - Must contain at least one character
40 | > - Must not contain any space characters
41 | > - In HTML, all values are case-insensitive
42 | 


--------------------------------------------------------------------------------
/messages/2.8.0.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 2.8.0
 2 | 
 3 | ## Changes
 4 | 
 5 | - Allow regular expressions in 'id_replacements' Ref: #113
 6 | 
 7 | ## Notice
 8 | 
 9 | Setting format has been changed.
10 | You have to modify `id_replacements` section if you customised `MarkdownTOC.sublime-settings` yourself.
11 | 
12 | old format:
13 | 
14 | ```json
15 | {
16 |   "id_replacements": {
17 |     "-": " ",
18 |     "" : ["!","#","$"]
19 |   }
20 | }
21 | ```
22 | 
23 | new format:
24 | 
25 | ```json
26 | {
27 |   "id_replacements": [
28 |     {
29 |       "pattern": "\\s",
30 |       "replacement": "-"
31 |     },
32 |     {
33 |       "pattern": "!|#|$",
34 |       "replacement": ""
35 |     }
36 |   ]
37 | }
38 | ```


--------------------------------------------------------------------------------
/messages/3.0.0.md:
--------------------------------------------------------------------------------
  1 | # MarkdownTOC - 3.0.0
  2 | 
  3 | ---
  4 | 
  5 | **NOTE**
  6 | This upgrade contains **breaking changes**.
  7 | Please follow "Upgrade guide from v2 to v3" for instructions.
  8 | 
  9 | ---
 10 | 
 11 | ## Changes
 12 | 
 13 | 1. `MarkdownTOC.sublime-settings` format has been changed.
 14 | 2. `default_bullets` is deprecated, use `defaults.bullets` instead.
 15 | 3. `default_depth` is deprecated, use `levels` instead. Ref: #55
 16 | 4. `lowercase_only_ascii` is deprecated, use `lowercase` instead with new value format. Ref: #105
 17 | 5. `defaults.bracket`(ex `default_bracket`) default value is changed to `"round"`
 18 | 6. Allow regular expressions in 'id_replacements', the format has been changed. Ref: #113
 19 | 
 20 | 
 21 | # Upgrade Guide
 22 | 
 23 | ## Upgrading from MarkdownTOC v2.x to v3
 24 | 
 25 | First of all `default_xxx` moves to `defaults.xxx`.
 26 | Please modify your settings if you have your own **User Settings**(`Packages/User/MarkdownTOC.sublime-settings`).
 27 | 
 28 | 
 29 | ### 1. `MarkdownTOC.sublime-settings` format has been changed
 30 | 
 31 | Old format:
 32 | 
 33 | ```json
 34 | 
 35 | {
 36 |   "default_autoanchor": false,
 37 |   "default_autolink": false,
 38 |   "default_indent": "\t",
 39 |   "default_remove_image": true,
 40 |   "default_link_prefix": "",
 41 |   "default_style": "unordered",
 42 |   "default_uri_encoding": true,
 43 |   "default_markdown_preview": false
 44 | }
 45 | ```
 46 | 
 47 | New format:
 48 | 
 49 | ```json
 50 | {
 51 |   "defaults": {
 52 |     "autoanchor": false,
 53 |     "autolink": false,
 54 |     "indent": "\t",
 55 |     "remove_image": true,
 56 |     "link_prefix": "",
 57 |     "style": "unordered",
 58 |     "uri_encoding": true,
 59 |     "markdown_preview": false
 60 |   }
 61 | }
 62 | ```
 63 | 
 64 | 
 65 | ### 2. `default_bullets` is deprecated, use `defaults.bullets` instead
 66 | 
 67 | Old format:
 68 | 
 69 | ```json
 70 | {
 71 |   "default_bullets": "-+*"
 72 | }
 73 | ```
 74 | 
 75 | or value could also be array.
 76 | 
 77 | ```json
 78 | {
 79 |   "default_bullets": ["-","+","*"]
 80 | }
 81 | ```
 82 | 
 83 | New format:
 84 | 
 85 | ```json
 86 | {
 87 |   "defaults": {
 88 |     "bullets": ["-","+","*"]
 89 |   }
 90 | }
 91 | ```
 92 | 
 93 | Note: Values type is 'array'
 94 | 
 95 | You can also override it as attribute
 96 | 
 97 | ```markdown
 98 | <!-- MarkdownTOC bullets="-,+,*" -->
 99 | ```
100 | 
101 | Note: Values type is 'comma separated strings'
102 | 
103 | 
104 | ### 3. `default_depth` is deprecated, use `defaults.levels` instead
105 | 
106 | Old format:
107 | 
108 | ```json
109 | {
110 |   "default_depth": 0
111 | }
112 | ```
113 | 
114 | New format:
115 | 
116 | ```json
117 | {
118 |   "defaults": {
119 |     "levels": [1,2,3,4,5,6]
120 |   }
121 | }
122 | ```
123 | 
124 | Note: Values type is 'array'
125 | 
126 | You can also override it as attribute
127 | 
128 | ```markdown
129 | <!-- MarkdownTOC levels="1,2,3" -->
130 | ```
131 | 
132 | Note:
133 | 
134 | - Values type is 'comma separated strings'
135 | - The default value changed to `[1,2,3,4,5,6]`, it means all headings(`h1`...`h6`) appear in TOC. Please override in your **User Settings**(`Packages/User/MarkdownTOC.sublime-settings`) if you prefer previous settings (e.g. `[1,2]`) or any others.
136 | 
137 | 
138 | ### 4. `lowercase_only_ascii` is deprecated, use `defaults.lowercase` instead
139 | 
140 | Old format:
141 | 
142 | ```json
143 | {
144 |   "lowercase": true,
145 |   "lowercase_only_ascii": true
146 | }
147 | ```
148 | 
149 | New format:
150 | 
151 | ```json
152 | {
153 |   "defaults": {
154 |     "lowercase": "only_ascii"
155 |   }
156 | }
157 | ```
158 | 
159 | Note: Values type is 'string' and allows following values `"only_ascii"`(default), `"all"` and `"false"`.
160 | 
161 | You can also override it as attribute
162 | 
163 | ```markdown
164 | <!-- MarkdownTOC lowercase="all" -->
165 | ```
166 | 
167 | See [docs](https://github.com/naokazuterada/MarkdownTOC#lowercasing-in-ids) for more detail.
168 | 
169 | 
170 | ### 5. `defaults.bracket`(ex `default_bracket`) default value is changed to `"round"`
171 | 
172 | The default value has been changed. So if you prefer `"square"` style, please override in your **User Settings**(`Packages/User/MarkdownTOC.sublime-settings`)
173 | 
174 | 
175 | ### 6. Allow regular expressions in 'id_replacements', the format has been changed
176 | 
177 | Setting format has been changed.
178 | You have to modify `id_replacements` section if you customised **User Settings**(`Packages/User/MarkdownTOC.sublime-settings`) yourself.
179 | 
180 | Old format:
181 | 
182 | ```json
183 | {
184 |   "id_replacements": {
185 |     "-": " ",
186 |     "" : ["!","#","$"]
187 |   }
188 | }
189 | ```
190 | 
191 | New format:
192 | 
193 | ```json
194 | {
195 |   "id_replacements": [
196 |     {
197 |       "pattern": "\\s",
198 |       "replacement": "-"
199 |     },
200 |     {
201 |       "pattern": "!|#|$",
202 |       "replacement": ""
203 |     }
204 |   ]
205 | }
206 | ```
207 | 


--------------------------------------------------------------------------------
/messages/3.0.1.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 3.0.1
2 | 
3 | ## Changes
4 | 
5 | - Fix the problem that User Settings overide Default values non-recursively Ref: #122
6 | 


--------------------------------------------------------------------------------
/messages/3.0.2.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 3.0.2
 2 | 
 3 | ---
 4 | 
 5 | **NOTE: 3.x has "breacking chnages"**
 6 | 
 7 | If you are using 3.x for the first time and have any problems, please check [Upgrade Guide](https://github.com/naokazuterada/MarkdownTOC/releases/tag/3.0.0) at first.
 8 | 
 9 | ---
10 | 
11 | ## Changes
12 | 
13 | - Fix errors when User Settings file is empty or not exist Ref: [#122](https://github.com/naokazuterada/MarkdownTOC/issues/122#issuecomment-375855044)
14 | 


--------------------------------------------------------------------------------
/messages/3.0.3.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 3.0.3
 2 | 
 3 | ---
 4 | 
 5 | **NOTE: 3.x has "breacking chnages"**
 6 | 
 7 | If you are using 3.x for the first time and have any problems, please check [Upgrade Guide](https://github.com/naokazuterada/MarkdownTOC/releases/tag/3.0.0) at first.
 8 | 
 9 | ---
10 | 
11 | ## Changes
12 | 
13 | - Show config json errors Ref: [#131](https://github.com/naokazuterada/MarkdownTOC/issues/131)
14 | 


--------------------------------------------------------------------------------
/messages/3.0.4.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 3.0.4
 2 | 
 3 | ---
 4 | 
 5 | **NOTE: 3.x has "breacking chnages"**
 6 | 
 7 | If you are using 3.x for the first time and have any problems, please check [Upgrade Guide](https://github.com/naokazuterada/MarkdownTOC/releases/tag/3.0.0) at first.
 8 | 
 9 | ---
10 | 
11 | ## Changes
12 | 
13 | - Fix anchor problem for italic texts Ref: [#136](https://github.com/naokazuterada/MarkdownTOC/issues/136)
14 | 


--------------------------------------------------------------------------------
/messages/3.0.5.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 3.0.5
 2 | 
 3 | ---
 4 | 
 5 | **NOTE: 3.x has "breacking chnages"**
 6 | 
 7 | If you are using 3.x for the first time and have any problems, please check [Upgrade Guide](https://github.com/naokazuterada/MarkdownTOC/releases/tag/3.0.0) at first.
 8 | 
 9 | ---
10 | 
11 | ## Changes
12 | 
13 | - Fix broking autolink when two or more _ (underscores) used in the title Ref: [#142](https://github.com/naokazuterada/MarkdownTOC/issues/142)


--------------------------------------------------------------------------------
/messages/4.0.0.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 4.0.0
 2 | 
 3 | ---
 4 | 
 5 | **NOTE: 4.0.0 may have "breaking changes"**
 6 | 
 7 | If there is a problem in autolink feature, please check your `MarkdownTOC.sublime-settings`.
 8 | 
 9 | But please be assured. The change is very easy!
10 | 
11 | Ref: [Upgrade Guide](https://github.com/naokazuterada/MarkdownTOC/releases/tag/4.0.0)
12 | 
13 | ## Upgrade Guide
14 | 
15 | Please remove following "patterns" in "id_replacements".
16 | 
17 | ```json
18 | {
19 |   "id_replacements": [
20 |     {
21 |       "pattern": "[_*]{2}([^\\s])[_*]{2}",
22 |       "replacement": "\\1"
23 |     },
24 |     {
25 |       "pattern": "[_*]([^\\s])[_*]",
26 |       "replacement": "\\1"
27 |     }
28 |   ]
29 | }
30 | ```
31 | 
32 | You do not need to do anything else.
33 | 
34 | ---
35 | 
36 | ## Changes
37 | 
38 | - Fix broking autolink when two or more _ (underscores) used in the title Ref: [#142](https://github.com/naokazuterada/MarkdownTOC/issues/142)
39 | - Remove duplicated "id_replacement" patterns in settings file
40 | 


--------------------------------------------------------------------------------
/messages/4.0.1.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 4.0.1
 2 | 
 3 | ---
 4 | 
 5 | **NOTE: 4.x may have "breaking changes"**
 6 | 
 7 | If you are using 4.x for the first time and have any problems, please check [Upgrade Guide](https://github.com/naokazuterada/MarkdownTOC/releases/tag/4.0.0) at first.
 8 | 
 9 | ---
10 | 
11 | ## Changes
12 | 
13 | - Fix the problem in ignoring comments in blocks of code Ref: [#146](https://github.com/naokazuterada/MarkdownTOC/issues/146)
14 | 


--------------------------------------------------------------------------------
/messages/4.0.2.md:
--------------------------------------------------------------------------------
 1 | # MarkdownTOC - 4.0.2
 2 | 
 3 | ---
 4 | 
 5 | **NOTE: 4.x may have "breaking changes"**
 6 | 
 7 | If you are using 4.x for the first time and have any problems, please check [Upgrade Guide](https://github.com/naokazuterada/MarkdownTOC/releases/tag/4.0.0) at first.
 8 | 
 9 | ---
10 | 
11 | ## Changes
12 | 
13 | - Fix the problem in Markdown Preview compatibility Ref: [#147](https://github.com/naokazuterada/MarkdownTOC/issues/147)
14 | 


--------------------------------------------------------------------------------
/messages/4.1.0.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 4.1.0
2 | 
3 | ## Changes
4 | 
5 | - Add Excluded heading feature Ref: [#140](https://github.com/naokazuterada/MarkdownTOC/issues/140), [#149](https://github.com/naokazuterada/MarkdownTOC/pull/149)
6 | - Update "Coding Style" in CONTRIBUTING.md
7 | 


--------------------------------------------------------------------------------
/messages/4.1.1.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 4.1.1
2 | 
3 | ## Changes
4 | 
5 | - Update `.python-version` Ref: [#158](https://github.com/naokazuterada/MarkdownTOC/issues/158)
6 | 


--------------------------------------------------------------------------------
/messages/4.1.2.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC - 4.1.2
2 | 
3 | ## Changes
4 | 
5 | - Add support for `.mdx` files Ref: [#160](https://github.com/naokazuterada/MarkdownTOC/issues/160)
6 | 


--------------------------------------------------------------------------------
/messages/install.md:
--------------------------------------------------------------------------------
1 | # MarkdownTOC
2 | 
3 | Sublime Text 3 plugin for generating a Table of Contents (TOC) in a Markdown document.
4 | 
5 | - [Features](https://github.com/naokazuterada/MarkdownTOC#features)
6 | - [Usage](https://github.com/naokazuterada/MarkdownTOC#usage)
7 | 


--------------------------------------------------------------------------------
/tests/autoanchor.py:
--------------------------------------------------------------------------------
 1 | # coding:utf-8
 2 | from base import TestBase
 3 | 
 4 | 
 5 | class TestAutoanchor(TestBase):
 6 |     """Test for attributes \'autoanchor\'"""
 7 | 
 8 |     # for debug
 9 |     # def tearDown(self):
10 |     #     pass
11 | 
12 |     text = """
13 | <!-- MarkdownTOC {0} -->
14 | 
15 | <!-- /MarkdownTOC -->
16 | 
17 | # Changelog
18 | # Glossary
19 | # API Specification
20 | """
21 | 
22 |     def test_autoanchor_default(self):
23 |         """autoanchor is 'false' in default"""
24 |         body_txt = self.init_update(self.text_with_autolink_true.format(""))["body"]
25 |         self.assert_NotIn('<a id="changelog"></a>\n# Changelog', body_txt)
26 |         self.assert_NotIn('<a id="glossary"></a>\n# Glossary', body_txt)
27 |         self.assert_NotIn('<a id="api-specification"></a>', body_txt)
28 | 
29 |     def test_autoanchor_true(self):
30 |         """If autoanchor is 'true' then added anchor"""
31 |         body_txt = self.init_update(self.text.format("autoanchor=true"))["body"]
32 |         self.assert_In('<a id="Changelog"></a>\n# Changelog', body_txt)
33 |         self.assert_In('<a id="Glossary"></a>\n# Glossary', body_txt)
34 |         self.assert_In('<a id="API-Specification"></a>\n# API Specification', body_txt)
35 | 
36 |     def test_autoanchor_false(self):
37 |         """If autoanchor is 'false' then it doesn't added anchor"""
38 |         body_txt = self.init_update(self.text.format("autoanchor=false"))["body"]
39 |         self.assert_NotIn('<a id="changelog"></a>', body_txt)
40 |         self.assert_NotIn('<a id="glossary"></a>', body_txt)
41 |         self.assert_NotIn('<a id="api-specification"></a>', body_txt)
42 | 
43 |     text_with_autolink_true = """
44 | 
45 | <!-- MarkdownTOC autolink=true {0} -->
46 | 
47 | <!-- /MarkdownTOC -->
48 | 
49 | # Changelog
50 | # Glossary
51 | # API Specification
52 | """
53 | 
54 |     def test_with_autolink_autoanchor_default(self):
55 |         """With autolink: autoanchor is 'false' in default"""
56 |         body_txt = self.init_update(self.text_with_autolink_true.format(""))["body"]
57 |         self.assert_NotIn('<a id="changelog"></a>\n# Changelog', body_txt)
58 |         self.assert_NotIn('<a id="glossary"></a>\n# Glossary', body_txt)
59 |         self.assert_NotIn('<a id="api-specification"></a>', body_txt)
60 | 
61 |     def test_with_autolink_autoanchor_true(self):
62 |         """With autolink: If autoanchor is 'true' then it adds anchor"""
63 |         body_txt = self.init_update(
64 |             self.text_with_autolink_true.format("autoanchor=true")
65 |         )["body"]
66 |         self.assert_In('<a id="changelog"></a>\n# Changelog', body_txt)
67 |         self.assert_In('<a id="glossary"></a>\n# Glossary', body_txt)
68 |         self.assert_In('<a id="api-specification"></a>\n# API Specification', body_txt)
69 | 
70 |     def test_with_autolink_autoanchor_false(self):
71 |         """With autolink: If autoanchor is 'false' then it doesn't added anchor"""
72 |         body_txt = self.init_update(
73 |             self.text_with_autolink_true.format("autoanchor=false")
74 |         )["body"]
75 |         self.assert_NotIn('<a id="changelog"></a>\n# Changelog', body_txt)
76 |         self.assert_NotIn('<a id="glossary"></a>\n# Glossary', body_txt)
77 |         self.assert_NotIn('<a id="api-specification"></a>', body_txt)
78 | 


--------------------------------------------------------------------------------
/tests/autolink.py:
--------------------------------------------------------------------------------
 1 | # coding:utf-8
 2 | from base import TestBase
 3 | 
 4 | 
 5 | class TestAutolink(TestBase):
 6 |     """Test for attributes \'autolink\'"""
 7 | 
 8 |     # for debug
 9 |     # def tearDown(self):
10 |     #     pass
11 | 
12 |     autolink_text = """
13 | 
14 | <!-- MarkdownTOC {0} -->
15 | 
16 | <!-- /MarkdownTOC -->
17 | 
18 | # Foo Bar
19 | """
20 | 
21 |     def test_autolink_default(self):
22 |         """Default Auto link is false"""
23 |         toc = self.init_update(self.autolink_text.format(""))["toc"]
24 |         self.assert_In("- Foo Bar", toc)
25 | 
26 |     def test_autolink_true(self):
27 |         toc = self.init_update(self.autolink_text.format("autolink=true"))["toc"]
28 |         self.assert_In("- [Foo Bar](#foo-bar)", toc)
29 | 
30 |     def test_autolink_false(self):
31 |         toc = self.init_update(self.autolink_text.format("autolink=false"))["toc"]
32 |         self.assert_In("- Foo Bar", toc)
33 | 


--------------------------------------------------------------------------------
/tests/base.py:
--------------------------------------------------------------------------------
  1 | # coding:utf-8
  2 | # import os
  3 | import re
  4 | import sublime
  5 | from unittest import TestCase
  6 | 
  7 | VERSION = sublime.version()
  8 | 
  9 | 
 10 | class TestBase(TestCase):
 11 |     """Super class includes common settings and functions. This class doesn't include any tests."""
 12 | 
 13 |     def setUp(self):
 14 |         self.view = sublime.active_window().new_file()
 15 |         # make sure we have a window to work with
 16 |         s = sublime.load_settings("Preferences.sublime-settings")
 17 |         s.set("close_windows_when_empty", False)
 18 | 
 19 |     def tearDown(self):
 20 |         if self.view:
 21 |             # close file
 22 |             self.view.set_scratch(True)
 23 |             self.view.window().focus_view(self.view)
 24 |             self.view.window().run_command("close_file")
 25 | 
 26 |     # -----
 27 | 
 28 |     def setText(self, string):
 29 |         self.view.run_command("insert", {"characters": string})
 30 | 
 31 |     def getRow(self, row):
 32 |         return self.view.substr(self.view.line(self.view.text_point(row, 0)))
 33 | 
 34 |     def moveTo(self, pos):
 35 |         """Move cursor to pos."""
 36 |         self.view.sel().clear()
 37 |         self.view.sel().add(sublime.Region(pos))
 38 | 
 39 |     def getTOC_text(self):
 40 |         """Find TOC in the document, and return the list texts in it."""
 41 |         toc_region = self.view.find(
 42 |             r"<!--[\s\n]+MarkdownTOC[\s\n]+[^>]*-->\n(.|\n)+?<!--[\s\n]+/MarkdownTOC[\s\n]+-->",
 43 |             sublime.IGNORECASE,
 44 |         )
 45 |         toc_all = self.view.substr(toc_region)
 46 | 
 47 |         # pick toc contents
 48 |         toc_contents = re.sub(r"<!--[\s\n]+MarkdownTOC[\s\n]+[^>]*-->", "", toc_all)
 49 |         toc_contents = re.sub(r"<!--[\s\n]+/MarkdownTOC[\s\n]+-->", "", toc_contents)
 50 |         toc_contents = toc_contents.rstrip()
 51 | 
 52 |         return toc_contents
 53 | 
 54 |     def init_insert(self, text, insert_position=3):
 55 |         # 1. load text
 56 |         self.setText(text)
 57 | 
 58 |         # 2. insert TOC
 59 |         # [NOTICE] Why insert_position=3 ?: Cannnot insert TOC when coursor position <= 2
 60 |         self.moveTo(insert_position)
 61 |         self.view.run_command("markdowntoc_insert")
 62 | 
 63 |         # 3. return TOC
 64 |         return self.getTOC_text()
 65 | 
 66 |     # def init_insertFile(self, filename, insert_position=3):
 67 |     #     # 1. load file
 68 |     #     file = os.path.join(os.path.dirname(__file__), 'samples/' + filename)
 69 |     #     text = open(file).read()
 70 |     #
 71 |     #     return self.init_insert(text, insert_position)
 72 | 
 73 |     def init_update(self, text):
 74 |         # 1. load text
 75 |         self.setText(text)
 76 | 
 77 |         # 2. update TOC
 78 |         self.view.run_command("markdowntoc_update")
 79 | 
 80 |         # 3. return TOC
 81 |         return {
 82 |             "toc": self.getTOC_text(),
 83 |             "body": self.view.substr(sublime.Region(0, self.view.size())),
 84 |         }
 85 | 
 86 |     # -----
 87 | 
 88 |     def assert_NotIn(self, txt, toc_txt):
 89 |         """Adapt assertNotIn to SublimeText2."""
 90 |         if VERSION < "3000":
 91 |             self.assertFalse(txt in toc_txt)
 92 |         else:
 93 |             self.assertNotIn(txt, toc_txt)
 94 | 
 95 |     def assert_In(self, txt, toc_txt):
 96 |         """Adapt assertIn to SublimeText2."""
 97 |         if VERSION < "3000":
 98 |             self.assertTrue(txt in toc_txt)
 99 |         else:
100 |             self.assertIn(txt, toc_txt)
101 | 


--------------------------------------------------------------------------------
/tests/bracket.py:
--------------------------------------------------------------------------------
 1 | # coding:utf-8
 2 | from base import TestBase
 3 | 
 4 | 
 5 | class TestBracket(TestBase):
 6 |     """Test for attributes \'bracket\'"""
 7 | 
 8 |     # for debug
 9 |     # def tearDown(self):
10 |     #     pass
11 | 
12 |     # TODO: How can we remove 'autolink=true' only in these tests below ?
13 | 
14 |     bracket_text = """
15 | 
16 | <!-- MarkdownTOC autolink=true {0} -->
17 | 
18 | <!-- /MarkdownTOC -->
19 | 
20 | # foo bar
21 | """
22 | 
23 |     def test_bracket_default(self):
24 |         """Default Bracket is round"""
25 |         toc = self.init_update(self.bracket_text.format(""))["toc"]
26 |         self.assert_In("- [foo bar](#foo-bar)", toc)
27 | 
28 |     def test_bracket_square(self):
29 |         toc = self.init_update(self.bracket_text.format("bracket=square"))["toc"]
30 |         self.assert_In("- [foo bar][foo-bar]", toc)
31 | 
32 |     def test_bracket_round(self):
33 |         toc = self.init_update(self.bracket_text.format("bracket=round"))["toc"]
34 |         self.assert_In("- [foo bar](#foo-bar)", toc)
35 | 


--------------------------------------------------------------------------------
/tests/default.py:
--------------------------------------------------------------------------------
  1 | # coding:utf-8
  2 | from base import TestBase
  3 | 
  4 | 
  5 | class TestDefault(TestBase):
  6 |     """Default tests"""
  7 | 
  8 |     # for debug
  9 |     # def tearDown(self):
 10 |     #     pass
 11 | 
 12 |     insert_position_text = """
 13 | # Heading 0
 14 | 
 15 | 
 16 | 
 17 | # Heading 1
 18 | 
 19 | ...
 20 | 
 21 | 
 22 | ## Heading 2
 23 | 
 24 | ...
 25 | 
 26 | 
 27 | ## Heading 3
 28 | 
 29 | ...
 30 | 
 31 | 
 32 | # Heading with anchor [with-anchor]
 33 | 
 34 | ...
 35 | """
 36 | 
 37 |     def test_before_than_TOC_should_be_ignored(self):
 38 |         toc = self.init_insert(self.insert_position_text, 13)
 39 |         self.assert_NotIn("Heading 0", toc)
 40 | 
 41 |     def test_after_than_TOC_should_be_included(self):
 42 |         toc = self.init_insert(self.insert_position_text, 13)
 43 |         self.assert_In("Heading 1", toc)
 44 |         self.assert_In("Heading 2", toc)
 45 |         self.assert_In("Heading 3", toc)
 46 |         self.assert_In("Heading with anchor", toc)
 47 | 
 48 |     def test_ignore_inside_codeblock(self):
 49 |         text = """
 50 | 
 51 | 
 52 | # heading1
 53 | 
 54 | ```
 55 | # heading2
 56 | ```
 57 | 
 58 | ```markdown
 59 | # heading3
 60 | ```
 61 | 
 62 | ```
 63 | 
 64 | # heading4
 65 | # heading5
 66 | 
 67 | ```
 68 | """
 69 |         toc = self.init_insert(text)
 70 |         self.assert_In("heading1", toc)
 71 |         self.assert_NotIn("heading3", toc)
 72 |         self.assert_NotIn("heading2", toc)
 73 |         self.assert_NotIn("heading4", toc)
 74 |         self.assert_NotIn("heading5", toc)
 75 | 
 76 |     def test_ignore_inside_codeblock_alt(self):
 77 |         text = """
 78 | 
 79 | 
 80 | # heading1
 81 | 
 82 | ~~~
 83 | # heading2
 84 | ~~~
 85 | 
 86 | ~~~markdown
 87 | # heading3
 88 | ~~~
 89 | 
 90 | ~~~
 91 | 
 92 | # heading4
 93 | # heading5
 94 | 
 95 | ~~~
 96 | """
 97 |         toc = self.init_insert(text)
 98 |         self.assert_In("heading1", toc)
 99 |         self.assert_NotIn("heading3", toc)
100 |         self.assert_NotIn("heading2", toc)
101 |         self.assert_NotIn("heading4", toc)
102 |         self.assert_NotIn("heading5", toc)
103 | 
104 |     def test_escape_link(self):
105 |         text = """
106 | 
107 | 
108 | # This [link](http://sample.com/) is cool
109 | """
110 |         toc = self.init_insert(text)
111 |         self.assert_In("This link is cool", toc)
112 | 
113 |     def test_escape_brackets(self):
114 |         """Broken reference when header has square brackets
115 |         https://github.com/naokazuterada/MarkdownTOC/issues/57
116 |         """
117 |         text = """
118 | 
119 | 
120 | # function(foo[, bar])
121 | """
122 |         toc = self.init_insert(text)
123 |         self.assert_In("function\(foo\[, bar\]\)", toc)
124 | 
125 |     def test_spaces_in_atx_heading(self):
126 |         text = """
127 | 
128 | 
129 | #Heading 0
130 | 
131 | #       Heading 1
132 | """
133 |         toc = self.init_insert(text)
134 |         self.assert_In("- Heading 0", toc)
135 |         self.assert_In("- Heading 1", toc)
136 | 
137 |     def test_remove_atx_closing_seq(self):
138 |         """ Remove closing sequence of # characters"""
139 |         text = """
140 | 
141 | 
142 | # Heading 0 #
143 | 
144 | 
145 | ## Heading 1       ###
146 | 
147 | 
148 | # Heading 2 ##########
149 | 
150 | 
151 | ## Heading 3
152 | """
153 |         toc = self.init_insert(text)
154 |         self.assert_In("Heading 0\n", toc)
155 |         self.assert_In("Heading 1\n", toc)
156 |         self.assert_In("Heading 2\n", toc)
157 | 
158 |     def test_id_replacement(self):
159 |         """ Reoplace chars(or string) in id_replacements object in id string"""
160 |         text = """
161 | 
162 | <!-- MarkdownTOC autolink=true -->
163 | 
164 | <!-- /MarkdownTOC -->
165 | 
166 | # Heading ! 0
167 | 
168 | # Heading # 1
169 | 
170 | # Heading !! 2
171 | 
172 | # Heading &and&and& 3
173 | 
174 | # &lt;element1>
175 | 
176 | # &#60;element2>
177 | """
178 |         toc = self.init_update(text)["toc"]
179 |         self.assert_In("- [Heading ! 0](#heading--0)", toc)
180 |         self.assert_In("- [Heading # 1](#heading--1)", toc)
181 |         self.assert_In("- [Heading !! 2](#heading--2)", toc)
182 |         self.assert_In("- [Heading &and&and& 3](#heading-andand-3)", toc)
183 |         self.assert_In("- [&lt;element1>](#element1)", toc)
184 |         self.assert_In("- [&#60;element2>](#element2)", toc)
185 | 
186 |     def test_no_escape_in_code(self):
187 |         """ No escape in codeblock"""
188 |         text = """
189 | 
190 | <!-- MarkdownTOC -->
191 | 
192 | <!-- /MarkdownTOC -->
193 | 
194 | # `function(param, [optional])`
195 | # (a static function) `greet([name])` (original, right?)
196 | # `add(keys, command[, args][, context])`
197 | # `get_context(key[, operator][, operand][, match_all])`
198 | """
199 |         toc = self.init_update(text)["toc"]
200 |         self.assert_In("- `function(param, [optional])`", toc)
201 |         self.assert_In(
202 |             "- \\(a static function\\) `greet([name])` \\(original, right?\\)", toc
203 |         )
204 |         self.assert_In("- `add(keys, command[, args][, context])`", toc)
205 |         self.assert_In("- `get_context(key[, operator][, operand][, match_all])`", toc)
206 | 
207 |     def test_no_escape_in_code_with_link(self):
208 |         """ No escape in codeblock (with link)"""
209 |         text = """
210 | 
211 | <!-- MarkdownTOC autolink=true -->
212 | 
213 | <!-- /MarkdownTOC -->
214 | 
215 | # `function(param, [optional])`
216 | # (a static function) `greet([name])` (original, right?)
217 | # `add(keys, command[, args][, context])`
218 | # `get_context(key[, operator][, operand][, match_all])`
219 | """
220 |         toc = self.init_update(text)["toc"]
221 |         self.assert_In(
222 |             "- [`function(param, [optional])`](#functionparam-optional)", toc
223 |         )
224 |         self.assert_In(
225 |             "- [\\(a static function\\) `greet([name])` \\(original, right?\\)](#a-static-function-greetname-original-right)",
226 |             toc,
227 |         )
228 |         self.assert_In(
229 |             "- [`add(keys, command[, args][, context])`](#addkeys-command-args-context)",
230 |             toc,
231 |         )
232 |         self.assert_In(
233 |             "- [`get_context(key[, operator][, operand][, match_all])`](#get_contextkey-operator-operand-match_all)",
234 |             toc,
235 |         )
236 | 
237 |     def test_no_headings(self):
238 |         """ No headings there"""
239 |         text = """
240 | 
241 | <!-- MarkdownTOC autolink=true -->
242 | 
243 | <!-- /MarkdownTOC -->
244 | 
245 | # `function(param, [optional])`
246 | # (a static function) `greet([name])` (original, right?)
247 | # `add(keys, command[, args][, context])`
248 | # `get_context(key[, operator][, operand][, match_all])`
249 | """
250 |         toc = self.init_update(text)["toc"]
251 |         self.assert_NotIn("^- ", toc)
252 | 
253 |     def test_uniquify_id_1(self):
254 |         """ uniquify id if there are same text headings"""
255 |         text = """
256 | 
257 | <!-- MarkdownTOC autolink=true -->
258 | 
259 | <!-- /MarkdownTOC -->
260 | 
261 | # Heading
262 | # Heading
263 | # Heading
264 | """
265 |         toc = self.init_update(text)["toc"]
266 |         self.assert_In("- [Heading](#heading)", toc)
267 |         self.assert_In("- [Heading](#heading-1)", toc)
268 |         self.assert_In("- [Heading](#heading-2)", toc)
269 | 
270 |     def test_uniquify_id_2(self):
271 |         """ handle = or - headings"""
272 |         text = """
273 | 
274 | <!-- MarkdownTOC autolink=true indent="  " -->
275 | 
276 | <!-- /MarkdownTOC -->
277 | 
278 | Heading 1
279 | =======
280 | 
281 | Heading 2
282 | -------
283 | """
284 |         toc = self.init_update(text)["toc"]
285 |         self.assert_In("- [Heading 1](#heading-1)", toc)
286 |         self.assert_In("  - [Heading 2](#heading-2)", toc)
287 | 
288 |     def test_whitespace_in_begining(self):
289 |         """Ignore images in heading"""
290 |         text = """
291 | 
292 | <!-- MarkdownTOC -->
293 | 
294 | <!-- /MarkdownTOC -->
295 | 
296 | # Heading
297 | #  Heading
298 | #   Heading
299 | """
300 |         toc = self.init_update(text)["toc"]
301 |         self.assert_In("- Heading", toc)
302 |         self.assert_NotIn("-  Heading", toc)
303 |         self.assert_NotIn("-   Heading", toc)
304 | 
305 |     def test_image_in_heading(self):
306 |         """Ignore images in heading"""
307 |         text = """
308 | 
309 | <!-- MarkdownTOC -->
310 | 
311 | <!-- /MarkdownTOC -->
312 | 
313 | # ![icon](images/icon.png) Heading
314 | # Image in ![icon](images/icon.png)sentence
315 | """
316 |         toc = self.init_update(text)["toc"]
317 |         self.assert_In("- Heading", toc)
318 |         self.assert_In("- Image in sentence", toc)
319 | 


--------------------------------------------------------------------------------
/tests/exclude_heading.py:
--------------------------------------------------------------------------------
 1 | # coding:utf-8
 2 | from base import TestBase
 3 | 
 4 | 
 5 | class TestExcludeHeading(TestBase):
 6 |     """Ignore exclude heading"""
 7 | 
 8 |     # for debug
 9 |     # def tearDown(self):
10 |     #     pass
11 | 
12 |     text_1 = """
13 | 
14 | <!-- MarkdownTOC -->
15 | 
16 | <!-- /MarkdownTOC -->
17 | 
18 | # heading 1
19 | 
20 | <!-- MarkdownTOC:excluded  -->
21 | # heading 2
22 | 
23 | # heading 3
24 | 
25 | """
26 | 
27 |     def test_exclude_heading(self):
28 |         """Default is no limit"""
29 |         toc = self.init_update(self.text_1)["toc"]
30 |         self.assert_In("- heading 1", toc)
31 |         self.assert_NotIn("- heading 2", toc)
32 |         self.assert_In("- heading 3", toc)
33 | 
34 |     text_2 = """
35 | 
36 | <!-- MarkdownTOC indent="  " -->
37 | 
38 | <!-- /MarkdownTOC -->
39 | 
40 | # level 1
41 | <!-- MarkdownTOC:excluded  -->
42 | ## level 2
43 | ### level 3
44 | <!-- MarkdownTOC:excluded  -->
45 | #### level 4
46 | <!-- MarkdownTOC:excluded  -->
47 | ##### level 5
48 | ###### level 6
49 | 
50 | """
51 | 
52 |     def test_exclude_heading_level(self):
53 |         """Existence and level is correct"""
54 |         toc = self.init_update(self.text_2)["toc"]
55 |         # existence
56 |         self.assert_NotIn("- level 2", toc)
57 |         self.assert_NotIn("- level 4", toc)
58 |         self.assert_NotIn("- level 5", toc)
59 |         # level
60 |         self.assert_In(
61 |             """- level 1
62 |   - level 3
63 |     - level 6""",
64 |             toc,
65 |         )
66 | 


--------------------------------------------------------------------------------
/tests/github_flavored_markdown.py:
--------------------------------------------------------------------------------
  1 | # coding:utf-8
  2 | from base import TestBase
  3 | 
  4 | 
  5 | class TestAutolink(TestBase):
  6 |     """Test for GitHub Flavored Markdown"""
  7 | 
  8 |     # for debug
  9 |     # def tearDown(self):
 10 |     #     pass
 11 | 
 12 |     def test_escaped_square_brackets(self):
 13 |         """Escaped square brackets"""
 14 |         toc_txt = self.init_update(
 15 |             """
 16 | 
 17 | <!-- MarkdownTOC autolink="true" bracket="round" -->
 18 | 
 19 | <!-- /MarkdownTOC -->
 20 | 
 21 | # variable \[required\]
 22 | """
 23 |         )["toc"]
 24 |         self.assert_In("- [variable \[required\]](#variable-required)", toc_txt)
 25 | 
 26 |     def test_underscores_asterisks_head(self):
 27 |         """Underscores and Asterisks in the head of line`"""
 28 |         toc_txt = self.init_update(
 29 |             """
 30 | 
 31 | <!-- MarkdownTOC autolink="true" bracket="round" -->
 32 | 
 33 | <!-- /MarkdownTOC -->
 34 | 
 35 | # _x test 1
 36 | # _x_ test 2
 37 | # *x* test 3
 38 | # _x _ test 4
 39 | # *x * test 5
 40 | # _ x_ test 6
 41 | # * x* test 7
 42 | # __x__ test 8
 43 | # **x** test 9
 44 | # __x __ test 10
 45 | # **x ** test 11
 46 | # __ x__ test 12
 47 | # ** x** test 13
 48 | # _x test 14
 49 | # x_ test 15
 50 | """
 51 |         )["toc"]
 52 |         self.assert_In("- [_x test 1](#_x-test-1)", toc_txt)
 53 |         self.assert_In("- [_x_ test 2](#x-test-2)", toc_txt)
 54 |         self.assert_In("- [*x* test 3](#x-test-3)", toc_txt)
 55 |         self.assert_In("- [_x _ test 4](#_x-_-test-4)", toc_txt)
 56 |         self.assert_In("- [*x * test 5](#x--test-5)", toc_txt)
 57 |         self.assert_In("- [_ x_ test 6](#_-x_-test-6)", toc_txt)
 58 |         self.assert_In("- [* x* test 7](#-x-test-7)", toc_txt)
 59 |         self.assert_In("- [__x__ test 8](#x-test-8)", toc_txt)
 60 |         self.assert_In("- [**x** test 9](#x-test-9)", toc_txt)
 61 |         self.assert_In("- [__x __ test 10](#__x-__-test-10)", toc_txt)
 62 |         self.assert_In("- [**x ** test 11](#x--test-11)", toc_txt)
 63 |         self.assert_In("- [__ x__ test 12](#__-x__-test-12)", toc_txt)
 64 |         self.assert_In("- [** x** test 13](#-x-test-13)", toc_txt)
 65 |         self.assert_In("- [_x test 14](#_x-test-14)", toc_txt)
 66 |         self.assert_In("- [x_ test 15](#x_-test-15)", toc_txt)
 67 | 
 68 |     def test_underscores_asterisks_tail(self):
 69 |         """Underscores and Asterisks in the end of line"""
 70 |         toc_txt = self.init_update(
 71 |             """
 72 | 
 73 | <!-- MarkdownTOC autolink="true" bracket="round" -->
 74 | 
 75 | <!-- /MarkdownTOC -->
 76 | 
 77 | # 1 test_x
 78 | # 2 test _x_
 79 | # 3 test *x*
 80 | # 4 test _x _
 81 | # 5 test *x *
 82 | # 6 test _ x_
 83 | # 7 test * x*
 84 | # 8 test __x__
 85 | # 9 test **x**
 86 | # 10 test __x __
 87 | # 11 test **x **
 88 | # 12 test __ x__
 89 | # 13 test ** x**
 90 | # 14 test _x
 91 | # 15 test x_
 92 | """
 93 |         )["toc"]
 94 |         self.assert_In("- [1 test_x](#1-test_x)", toc_txt)
 95 |         self.assert_In("- [2 test _x_](#2-test-x)", toc_txt)
 96 |         self.assert_In("- [3 test *x*](#3-test-x)", toc_txt)
 97 |         self.assert_In("- [4 test _x _](#4-test-_x-_)", toc_txt)
 98 |         self.assert_In("- [5 test *x *](#5-test-x-)", toc_txt)
 99 |         self.assert_In("- [6 test _ x_](#6-test-_-x_)", toc_txt)
100 |         self.assert_In("- [7 test * x*](#7-test--x)", toc_txt)
101 |         self.assert_In("- [8 test __x__](#8-test-x)", toc_txt)
102 |         self.assert_In("- [9 test **x**](#9-test-x)", toc_txt)
103 |         self.assert_In("- [10 test __x __](#10-test-__x-__)", toc_txt)
104 |         self.assert_In("- [11 test **x **](#11-test-x-)", toc_txt)
105 |         self.assert_In("- [12 test __ x__](#12-test-__-x__)", toc_txt)
106 |         self.assert_In("- [13 test ** x**](#13-test--x)", toc_txt)
107 |         self.assert_In("- [14 test _x](#14-test-_x)", toc_txt)
108 |         self.assert_In("- [15 test x_](#15-test-x_)", toc_txt)
109 | 
110 |     def test_underscores_asterisks_middle(self):
111 |         """Underscores and Asterisks in the middle of line"""
112 |         toc_txt = self.init_update(
113 |             """
114 | 
115 | <!-- MarkdownTOC autolink="true" bracket="round" -->
116 | 
117 | <!-- /MarkdownTOC -->
118 | 
119 | # 1_x test
120 | # 2 _x_ test
121 | # 3 *x* test
122 | # 4 _x _ test
123 | # 5 *x * test
124 | # 6 _ x_ test
125 | # 7 * x* test
126 | # 8 __x__ test
127 | # 9 **x** test
128 | # 10 __x __ test
129 | # 11 **x ** test
130 | # 12 __ x__ test
131 | # 13 ** x** test
132 | # 14 _x test
133 | # 15 x_ test
134 | """
135 |         )["toc"]
136 |         self.assert_In("- [1_x test](#1_x-test)", toc_txt)
137 |         self.assert_In("- [2 _x_ test](#2-x-test)", toc_txt)
138 |         self.assert_In("- [3 *x* test](#3-x-test)", toc_txt)
139 |         self.assert_In("- [4 _x _ test](#4-_x-_-test)", toc_txt)
140 |         self.assert_In("- [5 *x * test](#5-x--test)", toc_txt)
141 |         self.assert_In("- [6 _ x_ test](#6-_-x_-test)", toc_txt)
142 |         self.assert_In("- [7 * x* test](#7--x-test)", toc_txt)
143 |         self.assert_In("- [8 __x__ test](#8-x-test)", toc_txt)
144 |         self.assert_In("- [9 **x** test](#9-x-test)", toc_txt)
145 |         self.assert_In("- [10 __x __ test](#10-__x-__-test)", toc_txt)
146 |         self.assert_In("- [11 **x ** test](#11-x--test)", toc_txt)
147 |         self.assert_In("- [12 __ x__ test](#12-__-x__-test)", toc_txt)
148 |         self.assert_In("- [13 ** x** test](#13--x-test)", toc_txt)
149 |         self.assert_In("- [14 _x test](#14-_x-test)", toc_txt)
150 |         self.assert_In("- [15 x_ test](#15-x_-test)", toc_txt)
151 | 


--------------------------------------------------------------------------------
/tests/indent.py:
--------------------------------------------------------------------------------
 1 | # coding:utf-8
 2 | from base import TestBase
 3 | 
 4 | 
 5 | class TestIndent(TestBase):
 6 |     """Test for attributes \'indent\'"""
 7 | 
 8 |     # for debug
 9 |     # def tearDown(self):
10 |     #     pass
11 | 
12 |     indent_text = """
13 | 
14 | <!-- MarkdownTOC {0} -->
15 | 
16 | <!-- /MarkdownTOC -->
17 | 
18 | # foo
19 | ## bar
20 | ### buz
21 | #### qux
22 | """
23 |     # TODO: This test cannot be passed when tab(\t) is convert to space by sublime's other feature
24 |     # def test_indent_default(self):
25 |     #     '''Default indent is 1tab'''
26 |     #     toc = self.init_update(self.indent_text.format('levels="1,2,3,4,5,6"'))['toc']
27 |     #     self.assert_In('- foo', toc)
28 |     #     self.assert_In('\t- bar', toc)
29 |     #     self.assert_In('\t\t- buz', toc)
30 |     #     self.assert_In('\t\t\t- qux', toc)
31 | 
32 |     def test_indent_2spaces(self):
33 |         toc = self.init_update(
34 |             self.indent_text.format('levels="1,2,3,4,5,6" indent="  "')
35 |         )["toc"]
36 |         self.assert_In("- foo", toc)
37 |         self.assert_In("  - bar", toc)
38 |         self.assert_In("    - buz", toc)
39 |         self.assert_In("      - qux", toc)
40 | 
41 |     def test_indent_4spaces(self):
42 |         toc = self.init_update(
43 |             self.indent_text.format('levels="1,2,3,4,5,6" indent="    "')
44 |         )["toc"]
45 |         self.assert_In("- foo", toc)
46 |         self.assert_In("    - bar", toc)
47 |         self.assert_In("        - buz", toc)
48 |         self.assert_In("            - qux", toc)
49 | 


--------------------------------------------------------------------------------
/tests/italic_in_heading.py:
--------------------------------------------------------------------------------
  1 | # coding:utf-8
  2 | from base import TestBase
  3 | 
  4 | 
  5 | class TestItalic(TestBase):
  6 |     """Test for attributes \'bracket\'"""
  7 | 
  8 |     # for debug
  9 |     # def tearDown(self):
 10 |     #     pass
 11 | 
 12 |     # TODO: How can we remove 'autolink=true' only in these tests below ?
 13 | 
 14 |     bracket_text = """
 15 | 
 16 | <!-- MarkdownTOC autolink=true -->
 17 | 
 18 | <!-- /MarkdownTOC -->
 19 | 
 20 | # this is _italic_
 21 | # _this is italic_
 22 | # _this is not italic __
 23 | # this _is italic_
 24 | # _ this is not italic _
 25 | # 2 _ this is not italic _
 26 | # _this is not italic with markdown error _
 27 | # 2 _this is not italic with markdown error _
 28 | # `_should ignore underscores in codeblocks_`
 29 | # `_should ignore underscores in codeblocks 2_ `
 30 | # this is ` _more complex_ ` exmaple
 31 | # this_is_not_italic
 32 | # t_h_i_s__i_s__n_o_t__i_t_a_l_i_c
 33 | # _t_h_i_s__i_s__i_t_a_l_i_c_
 34 | """
 35 | 
 36 |     def test_italic_in_inheading1(self):
 37 |         toc = self.init_update(self.bracket_text)["toc"]
 38 |         self.assert_In("- [this is _italic_](#this-is-italic)", toc)
 39 | 
 40 |     def test_italic_in_inheading2(self):
 41 |         toc = self.init_update(self.bracket_text)["toc"]
 42 |         self.assert_In("- [_this is italic_](#this-is-italic-1)", toc)
 43 | 
 44 |     def test_italic_in_inheading3(self):
 45 |         toc = self.init_update(self.bracket_text)["toc"]
 46 |         self.assert_In("- [_this is not italic __](#_this-is-not-italic-__)", toc)
 47 | 
 48 |     def test_italic_in_inheading4(self):
 49 |         toc = self.init_update(self.bracket_text)["toc"]
 50 |         self.assert_In("- [this _is italic_](#this-is-italic-2)", toc)
 51 | 
 52 |     def test_italic_in_inheading5(self):
 53 |         toc = self.init_update(self.bracket_text)["toc"]
 54 |         self.assert_In("- [_ this is not italic _](#_-this-is-not-italic-_)", toc)
 55 | 
 56 |     def test_italic_in_inheading6(self):
 57 |         toc = self.init_update(self.bracket_text)["toc"]
 58 |         self.assert_In("- [2 _ this is not italic _](#2-_-this-is-not-italic-_)", toc)
 59 | 
 60 |     def test_italic_in_inheading7(self):
 61 |         toc = self.init_update(self.bracket_text)["toc"]
 62 |         self.assert_In(
 63 |             "- [_this is not italic with markdown error _](#_this-is-not-italic-with-markdown-error-_)",
 64 |             toc,
 65 |         )
 66 | 
 67 |     def test_italic_in_inheading8(self):
 68 |         toc = self.init_update(self.bracket_text)["toc"]
 69 |         self.assert_In(
 70 |             "- [2 _this is not italic with markdown error _](#2-_this-is-not-italic-with-markdown-error-_)",
 71 |             toc,
 72 |         )
 73 | 
 74 |     def test_italic_in_inheading9(self):
 75 |         toc = self.init_update(self.bracket_text)["toc"]
 76 |         self.assert_In(
 77 |             "- [`_should ignore underscores in codeblocks_`](#_should-ignore-underscores-in-codeblocks_)",
 78 |             toc,
 79 |         )
 80 | 
 81 |     def test_italic_in_inheading10(self):
 82 |         toc = self.init_update(self.bracket_text)["toc"]
 83 |         self.assert_In(
 84 |             "- [`_should ignore underscores in codeblocks 2_ `](#_should-ignore-underscores-in-codeblocks-2_-)",
 85 |             toc,
 86 |         )
 87 | 
 88 |     def test_italic_in_inheading11(self):
 89 |         toc = self.init_update(self.bracket_text)["toc"]
 90 |         self.assert_In(
 91 |             "- [this is ` _more complex_ ` exmaple](#this-is-_more-complex_-exmaple)",
 92 |             toc,
 93 |         )
 94 | 
 95 |     def test_italic_in_inheading12(self):
 96 |         toc = self.init_update(self.bracket_text)["toc"]
 97 |         self.assert_In("- [this_is_not_italic](#this_is_not_italic)", toc)
 98 | 
 99 |     def test_italic_in_inheading13(self):
100 |         toc = self.init_update(self.bracket_text)["toc"]
101 |         self.assert_In(
102 |             "- [t_h_i_s__i_s__n_o_t__i_t_a_l_i_c](#t_h_i_s__i_s__n_o_t__i_t_a_l_i_c)",
103 |             toc,
104 |         )
105 | 
106 |     def test_italic_in_inheading14(self):
107 |         toc = self.init_update(self.bracket_text)["toc"]
108 |         self.assert_In(
109 |             "- [_t_h_i_s__i_s__i_t_a_l_i_c_](#t_h_i_s__i_s__i_t_a_l_i_c)", toc
110 |         )
111 | 


--------------------------------------------------------------------------------
/tests/levels.py:
--------------------------------------------------------------------------------
  1 | # coding:utf-8
  2 | from base import TestBase
  3 | 
  4 | 
  5 | class TestLevels(TestBase):
  6 |     """Test for attributes \'levels\'"""
  7 | 
  8 |     # for debug
  9 |     # def tearDown(self):
 10 |     #     pass
 11 | 
 12 |     text_1 = """
 13 | 
 14 | <!-- MarkdownTOC {0} -->
 15 | 
 16 | <!-- /MarkdownTOC -->
 17 | 
 18 | # heading 1
 19 | ## heading 2
 20 | ### heading 3
 21 | #### heading 4
 22 | ##### heading 5
 23 | ###### heading 6
 24 | """
 25 |     # TODO: test warning if depth is exists in settings
 26 | 
 27 |     def appear_all_headings(self, toc):
 28 |         self.assert_In("- heading 1", toc)
 29 |         self.assert_In("- heading 2", toc)
 30 |         self.assert_In("- heading 3", toc)
 31 |         self.assert_In("- heading 4", toc)
 32 |         self.assert_In("- heading 5", toc)
 33 |         self.assert_In("- heading 6", toc)
 34 | 
 35 |     def test_levels_default(self):
 36 |         """Default is no limit"""
 37 |         toc = self.init_update(self.text_1.format(""))["toc"]
 38 |         self.appear_all_headings(toc)
 39 | 
 40 |     def test_levels_1(self):
 41 |         """levels="1" shows h1 """
 42 |         toc = self.init_update(self.text_1.format('levels="1"'))["toc"]
 43 |         self.assert_In("- heading 1", toc)
 44 |         self.assert_NotIn("- heading 2", toc)
 45 |         self.assert_NotIn("- heading 3", toc)
 46 |         self.assert_NotIn("- heading 4", toc)
 47 |         self.assert_NotIn("- heading 5", toc)
 48 |         self.assert_NotIn("- heading 6", toc)
 49 | 
 50 |     def test_levels_1_2(self):
 51 |         """levels="1,2" shows h1,h2 """
 52 |         toc = self.init_update(self.text_1.format('levels="1,2"'))["toc"]
 53 |         self.assert_In("- heading 1", toc)
 54 |         self.assert_In("- heading 2", toc)
 55 |         self.assert_NotIn("- heading 3", toc)
 56 |         self.assert_NotIn("- heading 4", toc)
 57 |         self.assert_NotIn("- heading 5", toc)
 58 |         self.assert_NotIn("- heading 6", toc)
 59 | 
 60 |     def test_levels_1_2_3(self):
 61 |         """levels="1,2,3" shows h1,h2,h3 """
 62 |         toc = self.init_update(self.text_1.format('levels="1,2,3"'))["toc"]
 63 |         self.assert_In("- heading 1", toc)
 64 |         self.assert_In("- heading 2", toc)
 65 |         self.assert_In("- heading 3", toc)
 66 |         self.assert_NotIn("- heading 4", toc)
 67 |         self.assert_NotIn("- heading 5", toc)
 68 |         self.assert_NotIn("- heading 6", toc)
 69 | 
 70 |     def test_levels_1_2_3_4(self):
 71 |         """levels="1,2,3,4" shows h1,h2,h3,h4 """
 72 |         toc = self.init_update(self.text_1.format('levels="1,2,3,4"'))["toc"]
 73 |         self.assert_In("- heading 1", toc)
 74 |         self.assert_In("- heading 2", toc)
 75 |         self.assert_In("- heading 3", toc)
 76 |         self.assert_In("- heading 4", toc)
 77 |         self.assert_NotIn("- heading 5", toc)
 78 |         self.assert_NotIn("- heading 6", toc)
 79 | 
 80 |     def test_levels_1_2_3_4_5(self):
 81 |         """levels="1,2,3,4,5" shows h1,h2,h3,h4,h5 """
 82 |         toc = self.init_update(self.text_1.format('levels="1,2,3,4,5"'))["toc"]
 83 |         self.assert_In("- heading 1", toc)
 84 |         self.assert_In("- heading 2", toc)
 85 |         self.assert_In("- heading 3", toc)
 86 |         self.assert_In("- heading 4", toc)
 87 |         self.assert_In("- heading 5", toc)
 88 |         self.assert_NotIn("- heading 6", toc)
 89 | 
 90 |     def test_levels_1_2_3_4_5_6(self):
 91 |         """levels="1,2,3,4,5" shows h1,h2,h3,h4,h5 """
 92 |         toc = self.init_update(self.text_1.format('levels="1,2,3,4,5,6"'))["toc"]
 93 |         self.appear_all_headings(toc)
 94 | 
 95 |     text_2 = """
 96 | 
 97 | <!-- MarkdownTOC {0} -->
 98 | 
 99 | <!-- /MarkdownTOC -->
100 | 
101 | ### heading 3
102 | #### heading 4
103 | # heading 1
104 | ## heading 2
105 | ##### heading 5
106 | ###### heading 6
107 | """
108 | 
109 |     def test_levels_specific_level(self):
110 |         """Default is no limit"""
111 |         toc = self.init_update(self.text_2.format('levels="3"'))["toc"]
112 |         self.assert_In("- heading 3", toc)
113 |         self.assert_NotIn("- heading 4", toc)
114 |         self.assert_NotIn("- heading 1", toc)
115 |         self.assert_NotIn("- heading 2", toc)
116 |         self.assert_NotIn("- heading 5", toc)
117 |         self.assert_NotIn("- heading 6", toc)
118 | 
119 |     def test_levels_specific_levels(self):
120 |         """Default is no limit"""
121 |         toc = self.init_update(self.text_2.format('levels="2,4,6"'))["toc"]
122 |         self.assert_NotIn("- heading 3", toc)
123 |         self.assert_In("- heading 4", toc)
124 |         self.assert_NotIn("- heading 1", toc)
125 |         self.assert_In("- heading 2", toc)
126 |         self.assert_NotIn("- heading 5", toc)
127 |         self.assert_In("- heading 6", toc)
128 | 


--------------------------------------------------------------------------------
/tests/link_prefix.py:
--------------------------------------------------------------------------------
 1 | # coding:utf-8
 2 | from base import TestBase
 3 | 
 4 | 
 5 | class LinkPrefixBullets(TestBase):
 6 |     """Test for attributes \'link_prefix\'"""
 7 | 
 8 |     # for debug
 9 |     # def tearDown(self):
10 |     #     pass
11 | 
12 |     link_prefix_text = """
13 | 
14 | <!-- MarkdownTOC autolink="true" {0} -->
15 | 
16 | <!-- /MarkdownTOC -->
17 | 
18 | # My Beatutiful Heading
19 | """
20 | 
21 |     def test_link_prefix_default(self):
22 |         toc = self.init_update(self.link_prefix_text.format(""))["toc"]
23 |         self.assert_In("- [My Beatutiful Heading](#my-beatutiful-heading)", toc)
24 | 
25 |     def test_link_prefix_1(self):
26 |         toc = self.init_update(
27 |             self.link_prefix_text.format('link_prefix="user-content-"')
28 |         )["toc"]
29 |         self.assert_In(
30 |             "- [My Beatutiful Heading](#user-content-my-beatutiful-heading)", toc
31 |         )
32 | 


--------------------------------------------------------------------------------
/tests/list_bullets.py:
--------------------------------------------------------------------------------
 1 | # coding:utf-8
 2 | from base import TestBase
 3 | 
 4 | 
 5 | class TestListBullets(TestBase):
 6 |     """Test for attributes \'bullets\'"""
 7 | 
 8 |     # for debug
 9 |     # def tearDown(self):
10 |     #     pass
11 | 
12 |     bullets_text = """
13 | 
14 | <!-- MarkdownTOC levels="1,2,3,4,5,6" {0} -->
15 | 
16 | <!-- /MarkdownTOC -->
17 | 
18 | # Heading1
19 | ## Heading2
20 | ## Heading2-2
21 | ### Heading3
22 | ### Heading3-2
23 | #### Heading4
24 | #### Heading4-2
25 | ##### Heading5
26 | ###### Heading6
27 | """
28 | 
29 |     def test_bullets_default(self):
30 |         toc = self.init_update(self.bullets_text.format(""))["toc"]
31 |         self.assert_In("- Heading1", toc)
32 |         self.assert_In("- Heading2", toc)
33 |         self.assert_In("- Heading2-2", toc)
34 |         self.assert_In("- Heading3", toc)
35 |         self.assert_In("- Heading3-2", toc)
36 |         self.assert_In("- Heading4", toc)
37 |         self.assert_In("- Heading4-2", toc)
38 |         self.assert_In("- Heading5", toc)
39 |         self.assert_In("- Heading6", toc)
40 | 
41 |     def test_bullets_2values(self):
42 |         toc = self.init_update(self.bullets_text.format('bullets="+,-"'))["toc"]
43 |         self.assert_In("+ Heading1", toc)
44 |         self.assert_In("- Heading2", toc)
45 |         self.assert_In("- Heading2-2", toc)
46 |         self.assert_In("+ Heading3", toc)
47 |         self.assert_In("+ Heading3-2", toc)
48 |         self.assert_In("- Heading4", toc)
49 |         self.assert_In("- Heading4-2", toc)
50 |         self.assert_In("+ Heading5", toc)
51 |         self.assert_In("- Heading6", toc)
52 | 
53 |     def test_bullets_3values(self):
54 |         toc = self.init_update(self.bullets_text.format('bullets="-,+,*"'))["toc"]
55 |         self.assert_In("- Heading1", toc)
56 |         self.assert_In("+ Heading2", toc)
57 |         self.assert_In("+ Heading2-2", toc)
58 |         self.assert_In("* Heading3", toc)
59 |         self.assert_In("* Heading3-2", toc)
60 |         self.assert_In("- Heading4", toc)
61 |         self.assert_In("- Heading4-2", toc)
62 |         self.assert_In("+ Heading5", toc)
63 |         self.assert_In("* Heading6", toc)
64 | 
65 |     def test_bullets_4values(self):
66 |         toc = self.init_update(self.bullets_text.format('bullets="-,+,-,*"'))["toc"]
67 |         self.assert_In("- Heading1", toc)
68 |         self.assert_In("+ Heading2", toc)
69 |         self.assert_In("+ Heading2-2", toc)
70 |         self.assert_In("- Heading3", toc)
71 |         self.assert_In("- Heading3-2", toc)
72 |         self.assert_In("* Heading4", toc)
73 |         self.assert_In("* Heading4-2", toc)
74 |         self.assert_In("- Heading5", toc)
75 |         self.assert_In("+ Heading6", toc)
76 | 


--------------------------------------------------------------------------------
/tests/lowercase.py:
--------------------------------------------------------------------------------
 1 | # coding:utf-8
 2 | from base import TestBase
 3 | 
 4 | 
 5 | class TestLowercase(TestBase):
 6 |     """Test for attributes \'lowercase\'"""
 7 | 
 8 |     # for debug
 9 |     # def tearDown(self):
10 |     #     pass
11 | 
12 |     text = """
13 | 
14 | <!-- MarkdownTOC autolink=true uri_encoding=false {0} -->
15 | 
16 | <!-- /MarkdownTOC -->
17 | 
18 | # ПРИМЕР EXAMPLE
19 | # One Two Three
20 | 
21 | """
22 | 
23 |     def get_only_ascii(self, toc):
24 |         self.assert_In("- [ПРИМЕР EXAMPLE](#ПРИМЕР-example)", toc)
25 |         self.assert_In("- [One Two Three](#one-two-three)", toc)
26 | 
27 |     def get_all(self, toc):
28 |         self.assert_In("- [ПРИМЕР EXAMPLE](#пример-example)", toc)
29 |         self.assert_In("- [One Two Three](#one-two-three)", toc)
30 | 
31 |     def get_none(self, toc):
32 |         self.assert_In("- [ПРИМЕР EXAMPLE](#ПРИМЕР-EXAMPLE)", toc)
33 |         self.assert_In("- [One Two Three](#One-Two-Three)", toc)
34 | 
35 |     def test_default(self):
36 |         toc = self.init_update(self.text.format(""))["toc"]
37 |         self.get_only_ascii(toc)
38 | 
39 |     def test_false(self):
40 |         toc = self.init_update(self.text.format('lowercase="false"'))["toc"]
41 |         self.get_none(toc)
42 | 
43 |     def test_only_ascii(self):
44 |         toc = self.init_update(self.text.format('lowercase="only_ascii"'))["toc"]
45 |         self.get_only_ascii(toc)
46 | 
47 |     def test_all(self):
48 |         toc = self.init_update(self.text.format('lowercase="all"'))["toc"]
49 |         self.get_all(toc)
50 | 
51 |     def test_others(self):
52 |         toc = self.init_update(self.text.format('lowercase="xxxxx"'))["toc"]
53 |         self.get_all(toc)
54 | 


--------------------------------------------------------------------------------
/tests/markdown_preview.py:
--------------------------------------------------------------------------------
  1 | # coding:utf-8
  2 | from base import TestBase
  3 | 
  4 | 
  5 | class TestMarkdownPreview(TestBase):
  6 |     """Test for attributes \'markdown_preview\'"""
  7 | 
  8 |     # for debug
  9 |     # def tearDown(self):
 10 |     #     pass
 11 | 
 12 |     markdown_preview_text = """
 13 | 
 14 | <!-- MarkdownTOC autolink=true uri_encoding=false {0} -->
 15 | 
 16 | <!-- /MarkdownTOC -->
 17 | 
 18 | # Hello 世界 World
 19 | # camión, último
 20 | # CAMIÓN, ÚLTIMO
 21 | # españa
 22 | # ESPAÑA
 23 | # пример russian
 24 | # ПРИМЕР RUSSIAN
 25 | """
 26 |     # TODO: Check MarkdownPreview installed or not
 27 | 
 28 |     # common result (not test, call inside test)
 29 |     def common_markdown_preview(self, toc):
 30 |         self.assert_In("- [Hello 世界 World](#hello-世界-world)", toc)
 31 |         self.assert_In("- [camión, último](#camión-último)", toc)
 32 |         self.assert_In("- [CAMIÓN, ÚLTIMO](#camiÓn-Último)", toc)
 33 |         self.assert_In("- [españa](#españa)", toc)
 34 |         self.assert_In("- [ESPAÑA](#espaÑa)", toc)
 35 |         self.assert_In("- [пример russian](#пример-russian)", toc)
 36 |         self.assert_In("- [ПРИМЕР RUSSIAN](#ПРИМЕР-russian)", toc)
 37 | 
 38 |     # default
 39 |     def test_markdown_preview_default(self):
 40 |         toc = self.init_update(self.markdown_preview_text.format(""))["toc"]
 41 |         self.common_markdown_preview(toc)
 42 | 
 43 |     # markdown
 44 |     def test_markdown_preview_markdown(self):
 45 |         toc = self.init_update(
 46 |             self.markdown_preview_text.format("markdown_preview=markdown")
 47 |         )["toc"]
 48 |         self.assert_In("- [Hello 世界 World](#hello-world)", toc)
 49 |         self.assert_In("- [camión, último](#camion-ultimo)", toc)
 50 |         self.assert_In("- [CAMIÓN, ÚLTIMO](#camion-ultimo_1)", toc)
 51 |         self.assert_In("- [españa](#espana)", toc)
 52 |         self.assert_In("- [ESPAÑA](#espana_1)", toc)
 53 |         self.assert_In("- [пример russian](#russian)", toc)
 54 |         self.assert_In("- [ПРИМЕР RUSSIAN](#russian_1)", toc)
 55 | 
 56 |     # github
 57 |     def test_markdown_preview_github(self):
 58 |         toc = self.init_update(
 59 |             self.markdown_preview_text.format("markdown_preview=github")
 60 |         )["toc"]
 61 |         self.assert_In("- [Hello 世界 World](#hello-%E4%B8%96%E7%95%8C-world)", toc)
 62 |         self.assert_In("- [camión, último](#cami%C3%B3n-%C3%BAltimo)", toc)
 63 |         self.assert_In("- [CAMIÓN, ÚLTIMO](#cami%C3%B3n-%C3%BAltimo-1)", toc)
 64 |         self.assert_In("- [españa](#espa%C3%B1a)", toc)
 65 |         self.assert_In("- [ESPAÑA](#espa%C3%B1a-1)", toc)
 66 |         self.assert_In(
 67 |             "- [пример russian](#%D0%BF%D1%80%D0%B8%D0%BC%D0%B5%D1%80-russian)", toc
 68 |         )
 69 |         self.assert_In(
 70 |             "- [ПРИМЕР RUSSIAN](#%D0%BF%D1%80%D0%B8%D0%BC%D0%B5%D1%80-russian-1)", toc
 71 |         )
 72 | 
 73 |     # the other values...
 74 |     def test_markdown_preview_othervalues(self):
 75 |         toc = self.init_update(
 76 |             self.markdown_preview_text.format("markdown_preview=othervalues")
 77 |         )["toc"]
 78 |         self.common_markdown_preview(toc)
 79 | 
 80 |     # uniquify heading's id
 81 |     markdown_preview_uniquify_id_text = """
 82 | 
 83 | <!-- MarkdownTOC autolink=true uri_encoding=false {0} -->
 84 | 
 85 | <!-- /MarkdownTOC -->
 86 | 
 87 | # Heading
 88 | # Heading
 89 | # Heading
 90 | """
 91 | 
 92 |     def test_markdown_preview_uniquify_id_markdown(self):
 93 |         toc = self.init_update(
 94 |             self.markdown_preview_uniquify_id_text.format("markdown_preview=markdown")
 95 |         )["toc"]
 96 |         self.assert_In("- [Heading](#heading)", toc)
 97 |         self.assert_In("- [Heading](#heading_1)", toc)
 98 |         self.assert_In("- [Heading](#heading_2)", toc)
 99 | 
100 |     def test_markdown_preview_uniquify_id_github(self):
101 |         toc = self.init_update(
102 |             self.markdown_preview_uniquify_id_text.format("markdown_preview=github")
103 |         )["toc"]
104 |         self.assert_In("- [Heading](#heading)", toc)
105 |         self.assert_In("- [Heading](#heading-1)", toc)
106 |         self.assert_In("- [Heading](#heading-2)", toc)
107 | 
108 |     # no headings
109 |     markdown_preview_no_heading_text = """
110 | 
111 | <!-- MarkdownTOC autolink=true uri_encoding=false {0} -->
112 | 
113 | <!-- /MarkdownTOC -->
114 | 
115 | """
116 | 
117 |     def test_markdown_preview_no_heading_markdown(self):
118 |         toc = self.init_update(
119 |             self.markdown_preview_no_heading_text.format("markdown_preview=markdown")
120 |         )["toc"]
121 |         self.assert_NotIn("^- ", toc)
122 | 
123 |     def test_markdown_preview_no_heading_github(self):
124 |         toc = self.init_update(
125 |             self.markdown_preview_no_heading_text.format("markdown_preview=github")
126 |         )["toc"]
127 |         self.assert_NotIn("^- ", toc)
128 | 


--------------------------------------------------------------------------------
/tests/quotes_in_attributes.py:
--------------------------------------------------------------------------------
 1 | # coding:utf-8
 2 | from base import TestBase
 3 | 
 4 | 
 5 | class TestQuotesInAttributes(TestBase):
 6 |     """Test for quotes in attributes"""
 7 | 
 8 |     # for debug
 9 |     # def tearDown(self):
10 |     #     pass
11 | 
12 |     text = """
13 | 
14 | <!-- MarkdownTOC {0} -->
15 | 
16 | <!-- /MarkdownTOC -->
17 | 
18 | # foo
19 | ## bar
20 | """
21 | 
22 |     def test_no_quote(self):
23 |         """Allow no quotes in attribute"""
24 |         toc = self.init_update(self.text.format("levels=1"))["toc"]
25 |         self.assert_In("- foo", toc)
26 |         self.assert_NotIn("- bar", toc)
27 | 
28 |     def test_single(self):
29 |         """Allow single quotes in attribute"""
30 |         toc = self.init_update(self.text.format("levels='1'"))["toc"]
31 |         self.assert_In("- foo", toc)
32 |         self.assert_NotIn("- bar", toc)
33 | 
34 |     def test_double(self):
35 |         """Allow single quotes in attribute"""
36 |         toc = self.init_update(self.text.format('levels="1"'))["toc"]
37 |         self.assert_In("- foo", toc)
38 |         self.assert_NotIn("- bar", toc)
39 | 


--------------------------------------------------------------------------------
/tests/remove_image.py:
--------------------------------------------------------------------------------
  1 | # coding:utf-8
  2 | from base import TestBase
  3 | 
  4 | 
  5 | class TestRemoveImage(TestBase):
  6 |     """Test for attributes \'remove_image\'"""
  7 | 
  8 |     # for debug
  9 |     # def tearDown(self):
 10 |     #     pass
 11 | 
 12 |     remove_image_text = """
 13 | 
 14 | <!-- MarkdownTOC {0} -->
 15 | 
 16 | <!-- /MarkdownTOC -->
 17 | 
 18 | # ![icon](img/icon.png) In the beginning
 19 | # In the ![icon](img/icon.png) middle
 20 | # In the last ![icon](img/icon.png)
 21 | # [link](http://sample.com) In the beginning
 22 | # In the [link](http://sample.com) middle
 23 | # In the last [link](http://sample.com)
 24 | """
 25 | 
 26 |     def common_remove_image_default(self, toc):
 27 |         self.assert_In("- In the beginning", toc)
 28 |         self.assert_In("- In the  middle", toc)
 29 |         self.assert_In("- In the last", toc)
 30 |         self.assert_In("- link In the beginning", toc)
 31 |         self.assert_In("- In the link middle", toc)
 32 |         self.assert_In("- In the last link", toc)
 33 | 
 34 |     def test_remove_image_default(self):
 35 |         toc = self.init_update(self.remove_image_text.format(""))["toc"]
 36 |         self.common_remove_image_default(toc)
 37 | 
 38 |     def test_remove_image_true(self):
 39 |         toc = self.init_update(self.remove_image_text.format('remove_image="true"'))[
 40 |             "toc"
 41 |         ]
 42 |         self.common_remove_image_default(toc)
 43 | 
 44 |     def test_remove_image_false(self):
 45 |         toc = self.init_update(self.remove_image_text.format('remove_image="false"'))[
 46 |             "toc"
 47 |         ]
 48 |         self.assert_In("- ![icon](img/icon.png) In the beginning", toc)
 49 |         self.assert_In("- In the ![icon](img/icon.png) middle", toc)
 50 |         self.assert_In("- In the last ![icon](img/icon.png)", toc)
 51 |         self.assert_In("- link In the beginning", toc)
 52 |         self.assert_In("- In the link middle", toc)
 53 |         self.assert_In("- In the last link", toc)
 54 | 
 55 |     remove_image_codeblock_text = """
 56 | 
 57 | <!-- MarkdownTOC {0} -->
 58 | 
 59 | <!-- /MarkdownTOC -->
 60 | 
 61 | # ![IMAGE](image.png) and [LINK](http://sample.com/) and [SQUARE] and (ROUND)
 62 | # hello![IMAGE](image.png) and [LINK](http://sample.com/) and [SQUARE] and (ROUND)
 63 | # `![IMAGE](image.png) and [LINK](http://sample.com/) and [SQUARE] and (ROUND)`
 64 | # hello`![IMAGE](image.png) and [LINK](http://sample.com/) and [SQUARE] and (ROUND)`
 65 | # `![IMAGE](image.png)` and `[LINK](http://sample.com/)` and `[SQUARE]` and `(ROUND)`
 66 | # hello`![IMAGE](image.png)` and `[LINK](http://sample.com/)` and `[SQUARE]` and `(ROUND)`
 67 | # `![IMAGE](image.png)`
 68 | # hello`![IMAGE](image.png)`
 69 | # `[LINK](http://sample.com/)`
 70 | # hello`[LINK](http://sample.com/)`
 71 | # [SQUARE] and (ROUND)
 72 | # `[SQUARE]` and `(ROUND)`
 73 | # `(ROUND)` and `[SQUARE]`
 74 | # hello[SQUARE] and (ROUND)
 75 | # hello`[SQUARE]` and `(ROUND)`
 76 | """
 77 | 
 78 |     def common_remove_image_codeblock_default(self, toc):
 79 |         self.assert_In("- and LINK and \[SQUARE\] and \(ROUND\)", toc)
 80 |         self.assert_In("- hello and LINK and \[SQUARE\] and \(ROUND\)", toc)
 81 |         self.assert_In("- `![IMAGE](image.png) and LINK and [SQUARE] and (ROUND)`", toc)
 82 |         self.assert_In(
 83 |             "- hello`![IMAGE](image.png) and LINK and [SQUARE] and (ROUND)`", toc
 84 |         )
 85 |         self.assert_In(
 86 |             "- `![IMAGE](image.png)` and `LINK` and `[SQUARE]` and `(ROUND)`", toc
 87 |         )
 88 |         self.assert_In(
 89 |             "- hello`![IMAGE](image.png)` and `LINK` and `[SQUARE]` and `(ROUND)`", toc
 90 |         )
 91 |         self.assert_In("- `![IMAGE](image.png)`", toc)
 92 |         self.assert_In("- hello`![IMAGE](image.png)`", toc)
 93 |         self.assert_In("- `LINK`", toc)
 94 |         self.assert_In("- hello`LINK`", toc)
 95 |         self.assert_In("- \[SQUARE\] and \(ROUND\)", toc)
 96 |         self.assert_In("- `[SQUARE]` and `(ROUND)`", toc)
 97 |         self.assert_In("- `(ROUND)` and `[SQUARE]`", toc)
 98 |         self.assert_In("- hello\[SQUARE\] and \(ROUND\)", toc)
 99 |         self.assert_In("- hello`[SQUARE]` and `(ROUND)`", toc)
100 | 
101 |     def test_remove_image_codeblock_default(self):
102 |         toc = self.init_update(self.remove_image_codeblock_text.format(""))["toc"]
103 |         self.common_remove_image_codeblock_default(toc)
104 | 
105 |     def test_remove_image_codeblock_true(self):
106 |         toc = self.init_update(
107 |             self.remove_image_codeblock_text.format('remove_image="true"')
108 |         )["toc"]
109 |         self.common_remove_image_codeblock_default(toc)
110 | 
111 |     def test_remove_image_codeblock_false(self):
112 |         toc = self.init_update(
113 |             self.remove_image_codeblock_text.format('remove_image="false"')
114 |         )["toc"]
115 |         self.assert_In(
116 |             "- ![IMAGE](image.png) and LINK and \[SQUARE\] and \(ROUND\)", toc
117 |         )
118 |         self.assert_In(
119 |             "- hello![IMAGE](image.png) and LINK and \[SQUARE\] and \(ROUND\)", toc
120 |         )
121 |         self.assert_In("- `![IMAGE](image.png) and LINK and [SQUARE] and (ROUND)`", toc)
122 |         self.assert_In(
123 |             "- hello`![IMAGE](image.png) and LINK and [SQUARE] and (ROUND)`", toc
124 |         )
125 |         self.assert_In(
126 |             "- `![IMAGE](image.png)` and `LINK` and `[SQUARE]` and `(ROUND)`", toc
127 |         )
128 |         self.assert_In(
129 |             "- hello`![IMAGE](image.png)` and `LINK` and `[SQUARE]` and `(ROUND)`", toc
130 |         )
131 |         self.assert_In("- `![IMAGE](image.png)`", toc)
132 |         self.assert_In("- hello`![IMAGE](image.png)`", toc)
133 |         self.assert_In("- `LINK`", toc)
134 |         self.assert_In("- hello`LINK`", toc)
135 |         self.assert_In("- \[SQUARE\] and \(ROUND\)", toc)
136 |         self.assert_In("- `[SQUARE]` and `(ROUND)`", toc)
137 |         self.assert_In("- `(ROUND)` and `[SQUARE]`", toc)
138 |         self.assert_In("- hello\[SQUARE\] and \(ROUND\)", toc)
139 |         self.assert_In("- hello`[SQUARE]` and `(ROUND)`", toc)
140 | 


--------------------------------------------------------------------------------
/tests/style.py:
--------------------------------------------------------------------------------
 1 | # coding:utf-8
 2 | from base import TestBase
 3 | 
 4 | 
 5 | class TestStyle(TestBase):
 6 |     """Test for attributes \'style\'"""
 7 | 
 8 |     # for debug
 9 |     # def tearDown(self):
10 |     #     pass
11 | 
12 |     style_text = """
13 | 
14 | <!-- MarkdownTOC {0} -->
15 | 
16 | <!-- /MarkdownTOC -->
17 | 
18 | # foo
19 | ## bar
20 | ## buz
21 | # qux
22 | """
23 | 
24 |     def test_style_default(self):
25 |         """Default Style is unordered"""
26 |         toc = self.init_update(self.style_text.format(""))["toc"]
27 |         self.assert_In("- foo", toc)
28 |         self.assert_In("- bar", toc)
29 |         self.assert_In("- buz", toc)
30 |         self.assert_In("- qux", toc)
31 | 
32 |     def test_style_ordered(self):
33 |         toc = self.init_update(self.style_text.format("style=ordered"))["toc"]
34 |         self.assert_In("1. foo", toc)
35 |         self.assert_In("1. bar", toc)
36 |         self.assert_In("1. buz", toc)
37 |         self.assert_In("1. qux", toc)
38 | 
39 |     def test_style_unordered(self):
40 |         toc = self.init_update(self.style_text.format("style=unordered"))["toc"]
41 |         self.assert_In("- foo", toc)
42 |         self.assert_In("- bar", toc)
43 |         self.assert_In("- buz", toc)
44 |         self.assert_In("- qux", toc)
45 | 


--------------------------------------------------------------------------------
/tests/tag_variation.py:
--------------------------------------------------------------------------------
 1 | # coding:utf-8
 2 | from base import TestBase
 3 | 
 4 | 
 5 | class TagVariation(TestBase):
 6 |     """Test for attributes \'style\'"""
 7 | 
 8 |     # for debug
 9 |     # def tearDown(self):
10 |     #     pass
11 | 
12 |     def test_1(self):
13 |         """Tag Variation 1"""
14 |         text = """
15 | 
16 | <!-- MarkdownTOC autolink="true" bracket="square" style="ordered" -->
17 | 
18 | <!-- /MarkdownTOC -->
19 | 
20 | # foo
21 | """
22 |         toc = self.init_update(text)["toc"]
23 |         self.assert_In("1. [foo][foo]", toc)
24 | 
25 |     def test_2(self):
26 |         """Tag Variation 2"""
27 |         text = """
28 | 
29 | <!-- MarkdownTOC
30 | autolink="true" bracket="square" style="ordered" -->
31 | 
32 | <!-- /MarkdownTOC -->
33 | 
34 | # foo
35 | """
36 |         toc = self.init_update(text)["toc"]
37 |         self.assert_In("1. [foo][foo]", toc)
38 | 
39 |     def test_3(self):
40 |         """Tag Variation 3"""
41 |         text = """
42 | 
43 | <!--
44 | MarkdownTOC
45 | autolink="true"
46 | bracket="square"
47 | style="ordered" -->
48 | 
49 | <!-- /MarkdownTOC -->
50 | 
51 | # foo
52 | """
53 |         toc = self.init_update(text)["toc"]
54 |         self.assert_In("1. [foo][foo]", toc)
55 | 
56 |     def test_4(self):
57 |         """Tag Variation 4"""
58 |         text = """
59 | 
60 | <!--
61 | MarkdownTOC
62 | autolink="true"
63 | bracket="square"
64 | style="ordered"
65 | -->
66 | 
67 | <!-- /MarkdownTOC -->
68 | 
69 | # foo
70 | """
71 |         toc = self.init_update(text)["toc"]
72 |         self.assert_In("1. [foo][foo]", toc)
73 | 
74 |     def test_5(self):
75 |         """Tag Variation 5"""
76 |         text = """
77 | 
78 | <!--
79 | MarkdownTOC
80 | autolink="true"
81 | bracket="square"
82 | style="ordered"
83 | -->
84 | 
85 | <!--
86 | /MarkdownTOC
87 | -->
88 | 
89 | # foo
90 | """
91 |         toc = self.init_update(text)["toc"]
92 |         self.assert_In("1. [foo][foo]", toc)
93 | 


--------------------------------------------------------------------------------
/tests/uri_encoding.py:
--------------------------------------------------------------------------------
 1 | # coding:utf-8
 2 | from base import TestBase
 3 | 
 4 | 
 5 | class TestUriEncoding(TestBase):
 6 |     """Test for attributes \'uri_encoding\'"""
 7 | 
 8 |     # for debug
 9 |     # def tearDown(self):
10 |     #     pass
11 | 
12 |     uri_encoding_text = """
13 | 
14 | <!-- MarkdownTOC autolink="true" lowercase="only_ascii" {0} -->
15 | 
16 | <!-- /MarkdownTOC -->
17 | 
18 | # Camión, último
19 | # España
20 | # こんにちわ 世界
21 | # Пример Example
22 | # 一个标题
23 | """
24 |     # default: uri_encoding=true
25 |     def test_uri_encoding_default(self):
26 |         toc = self.init_update(self.uri_encoding_text.format(""))["toc"]
27 |         self.assert_In("- [Camión, último](#cami%C3%B3n-%C3%BAltimo)", toc)
28 |         self.assert_In("- [España](#espa%C3%B1a)", toc)
29 |         self.assert_In(
30 |             "- [こんにちわ 世界](#%E3%81%93%E3%82%93%E3%81%AB%E3%81%A1%E3%82%8F-%E4%B8%96%E7%95%8C)",
31 |             toc,
32 |         )
33 |         self.assert_In(
34 |             "- [Пример Example](#%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80-example)", toc
35 |         )
36 |         self.assert_In("- [一个标题](#%E4%B8%80%E4%B8%AA%E6%A0%87%E9%A2%98)", toc)
37 | 
38 |     def test_uri_encoding_true(self):
39 |         toc = self.init_update(self.uri_encoding_text.format("uri_encoding=true"))[
40 |             "toc"
41 |         ]
42 |         self.assert_In("- [Camión, último](#cami%C3%B3n-%C3%BAltimo)", toc)
43 |         self.assert_In("- [España](#espa%C3%B1a)", toc)
44 |         self.assert_In(
45 |             "- [こんにちわ 世界](#%E3%81%93%E3%82%93%E3%81%AB%E3%81%A1%E3%82%8F-%E4%B8%96%E7%95%8C)",
46 |             toc,
47 |         )
48 |         self.assert_In(
49 |             "- [Пример Example](#%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80-example)", toc
50 |         )
51 |         self.assert_In("- [一个标题](#%E4%B8%80%E4%B8%AA%E6%A0%87%E9%A2%98)", toc)
52 | 
53 |     def test_uri_encoding_false(self):
54 |         toc = self.init_update(self.uri_encoding_text.format("uri_encoding=false"))[
55 |             "toc"
56 |         ]
57 |         self.assert_In("- [Camión, último](#camión-último)", toc)
58 |         self.assert_In("- [España](#españa)", toc)
59 |         self.assert_In("- [こんにちわ 世界](#こんにちわ-世界)", toc)
60 |         self.assert_In("- [Пример Example](#Пример-example)", toc)
61 |         self.assert_In("- [一个标题](#一个标题)", toc)
62 | 


--------------------------------------------------------------------------------
/unittesting.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "tests_dir" : "tests",
 3 |   "pattern" : "*.py",
 4 |   "async": false,
 5 |   "deferred": false,
 6 |   "verbosity": 2,
 7 |   "capture_console": false, // Set true if you want to enable print
 8 |   "output": "<panel>"
 9 | }
10 | 


--------------------------------------------------------------------------------