Skip to main content

Markdown extension for vimwiki todos and tags

Project description

markdown_vimwiki

Python Markdown extension for useful vimwiki additions

Todo lists

The plugin supports the standard vimwiki style todo lists:

* [ ] To do
* [.] 0-33% complete
* [o] 33-66% complete
* [O] 66-99% complete
* [X] 100% complete
* [-] rejected

leads to:

<ul>
<li class="done0"> done0</li>
<li class="done1"> done1</li>
<li class="done2"> done2</li>
<li class="done3"> done3</li>
<li class="done4"> done4</li>
<li class="rejected"> rejected</li>
</ul>

By default, it uses all the same defaults as vimwiki's syntax. That is, it uses .oOX for g:vimwiki_listsyms and - for g:vimwiki_listsym_rejected, and applies the CSS classes used by the default HTML generation tool.

These are customizable. For the following markdown:

* [i] yip
* [a] yap
* [o] yop

expecting:

<ul>
<li class="yip"> yip</li>
<li class="yap"> yap</li>
<li class="yop"> yop</li>
</ul>

configure as follows:

markdown(source, extensions=[VimwikiExtension(
    list_levels='iao',
    list_classes=['yip', 'yap', 'yop'])])

Tags

The plugin currently supports styling tags (but nothing else):

:lorem:ipsum:

leads to:

<p><span class="tag">lorem</span> <span class="tag">ipsum</span></p>

The class used is customizable with the tag_class config option.

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

markdown_vimwiki-0.1.2.tar.gz (2.8 kB view hashes)

Uploaded Source

Built Distribution

markdown_vimwiki-0.1.2-py3-none-any.whl (4.1 kB view hashes)

Uploaded Python 3

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