Metadata-Version: 2.1
Name: vimwiki-markdown
Version: 0.4.0
Summary: vimwiki-markdown: vimwiki markdown file to html with syntax highlighting.
Home-page: https://github.com/WnP/vimwiki_markdown/
Author: Steeve Chailloux
Author-email: steeve@chailloux.me
License: MIT License
Description: # vimwiki-markdown
        
        [![PyPI version](https://badge.fury.io/py/vimwiki-markdown.svg)](https://badge.fury.io/py/vimwiki-markdown) ![PyPI downloads](https://img.shields.io/pypi/dm/vimwiki-markdown.svg)
        
        [vimwiki](https://github.com/vimwiki/vimwiki) markdown file to html with syntax
        highlighting.
        
        ## Install
        
        ```
        pip install vimwiki-markdown
        ```
        
        ## Usage
        
        Add the following to your `~/.vimrc`:
        
        ```vim
        let g:vimwiki_list = [{
        	\ 'path': '~/vimwiki',
        	\ 'template_path': '~/vimwiki/templates/',
        	\ 'template_default': 'default',
        	\ 'syntax': 'markdown',
        	\ 'ext': '.md',
        	\ 'path_html': '~/vimwiki/site_html/',
        	\ 'custom_wiki2html': 'vimwiki_markdown',
        	\ 'template_ext': '.tpl'}]
        ```
        
        ## Markdown extensions
        
        The following [markdown extensions](https://python-markdown.github.io/extensions/)
        are activated by default:
        
        - [fenced_code](https://python-markdown.github.io/extensions/fenced_code_blocks/)
        - [tables](https://python-markdown.github.io/extensions/tables/)
        - [CodeHilite](https://python-markdown.github.io/extensions/code_hilite/)
        
        But you can add more extensions using `VIMWIKI_MARKDOWN_EXTENSIONS` environment variable:
        1. Json dictionary syntax of extension with configuration
        	 `{"toc": {"baselevel": 2 }, "nl2br": {}}`.
        	 **Note**: `{}` configuration implies no configuration.
        1. [DEPRECATED] Json list syntax of extension. `["toc", "nl2br"]`.
        1. [DEPRECATED] comma separated list of extensions `toc,nl2br`.
        
        **Warning** Deprecated formats will be remove in next major release
        
        ## Syntax highlighting
        
        Syntax highlighting is provided by [Pygments](http://pygments.org/), which will
        try to guess language by default.
        
        You can use regular markdown indented code blocks:
        
        ```
        	:::python
        	for value range(42):
        		print(value)
        ```
        
        Or Fenced Code Blocks
        
        	```python
        	for value range(42):
        		print(value)
        	```
        
        You can also highlight line using `hl_lines` argument:
        
        	```python hl_lines="1 3"
        	for value range(42):
        		print(value)
        	```
        
        Pygments can generate CSS rules for you. Just run the following command from
        the command line:
        
        ```
        pygmentize -S default -f html -a .codehilite > styles.css
        ```
        
        If you would like to use a different theme, swap out `default` for the desired
        theme. For a list of themes installed on your system, run the following
        command:
        
        ```
        pygmentize -L style
        ```
        
        If you are lazy you can just use the one in this repository inside `css`
        directory which provide the `monokai` theme.
        
        ## Environment variables
        
        The following environment variables are available, but not mandatory:
        
        - `VIMWIKI_TEMPLATE_PATH`: path to vimwiki HTML template
        - `VIMWIKI_TEMPLATE_DEFAULT`: default HTML template name
        - `VIMWIKI_TEMPLATE_EXT`: default HTML template extension
        - `VIMWIKI_ROOT_PATH`: vimwiki root path
        
        If not set `vimwiki_markdown` will use
        [the default template defined in the source code](https://github.com/WnP/vimwiki_markdown/blob/master/vimwiki_markdown.py#L12-L30).
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Text Editors
Description-Content-Type: text/markdown
