Skip to main content

Generates ctags-compatible output for the sections of a Markdown document.

Project description

This application generates ctags-compatible output for the sections of a Markdown document.

The motivation was to have a tool fast enough to use with the TagBar plugin in Vim.

Using with TagBar

To use this tool with TagBar, add the following into your ~/.vimrc:

" Add support for markdown files in tagbar.
let g:tagbar_type_markdown = {
    \ 'ctagstype': 'markdown',
    \ 'ctagsbin' : '/path/to/markdown2ctags.py',
    \ 'ctagsargs' : '-f - --sort=yes --sro=»',
    \ 'kinds' : [
        \ 's:sections',
        \ 'i:images'
    \ ],
    \ 'sro' : '»',
    \ 'kind2scope' : {
        \ 's' : 'section',
    \ },
    \ 'sort': 0,
\ }

You’ll need to have the TagBar plugin installed for this to work. Also, you may need to call the variable g:tagbar_type_mkd and change ctagstype to 'mkd' if you’re Ben William’s Markdown syntax highlighting script. It sets the file type to mkd whereas Tim Pope’s sets it to markdown.

License

This tool is licensed under a Simplified BSD license. See LICENSE.txt for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markdown2ctags-0.3.3.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

markdown2ctags-0.3.3-py2.py3-none-any.whl (7.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file markdown2ctags-0.3.3.tar.gz.

File metadata

  • Download URL: markdown2ctags-0.3.3.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.5

File hashes

Hashes for markdown2ctags-0.3.3.tar.gz
Algorithm Hash digest
SHA256 c274e0b208604cda5e426026e802a17db054b24110351218b124be6627c1908e
MD5 0f930a1297f6392abc7e63a3eb696b30
BLAKE2b-256 2bad7542bf7ff34effc010c63dcf3e10c745e54806da751975672c0ddaf5d45c

See more details on using hashes here.

File details

Details for the file markdown2ctags-0.3.3-py2.py3-none-any.whl.

File metadata

  • Download URL: markdown2ctags-0.3.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.5

File hashes

Hashes for markdown2ctags-0.3.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1ad113717acd4a9c335cf12d38315ffeb9a3523dfae12a07e1c4eb95b8b8c8a9
MD5 8ccd3bf905f10ac3e92d662944f50480
BLAKE2b-256 1d8145a500156e697dc988b3196a5ea129e7a0941eafe9e0c4259a66f3b90024

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page