Metadata-Version: 1.1
Name: markdown2ctags
Version: 0.2.5
Summary: Generates ctags-compatible output for the sections of a Markdown document.
Home-page: https://github.com/jszakmeister/markdown2ctags
Author: John Szakmeister
Author-email: john@szakmeister.net
License: BSD
Description: **************
        markdown2ctags
        **************
        
        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 <https://github.com/majutsushi/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,
            \ }
        
        .. note::
        
            The suggested ``sro`` used to be ``|``, but this symbol could be used in
            headings (when talking about logical operators, for example).  As a result,
            I recommend using something like the UTF-8 chevron above and specifying this
            new sro character on the command line via the ``--sro`` option.
        
        You'll need to have the TagBar plugin installed for this to work.  Also, you
        make 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.
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Classifier: Topic :: Text Processing
Classifier: Topic :: Text Processing :: Indexing
Classifier: Topic :: Utilities
