vimwiki-markdown: vimwiki markdown file to html with syntax highlighting.
Project description
vimwiki-markdown
vimwiki markdown file to html with syntax highlighting.
Install
pip install vimwiki-markdown
Usage
Add the following to your ~/.vimrc
:
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 are activated by default:
But you can add more extensions using VIMWIKI_MARKDOWN_EXTENSIONS
environment
variable, which is a coma separated list of extensions.
Syntax highlighting
Syntax highlighting is provided by Pygments, 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 juste use the one in this repository inside css
directory which provide the monokai
theme.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for vimwiki_markdown-0.3.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84e8a1694725e5c911220d38e1f703869afe27bb8afd9c63a8847761aa4cbf9f |
|
MD5 | 585a49e200c48a83640d36f2c8eb308a |
|
BLAKE2b-256 | 4c7aa2e93ab3fa74ace09f1eacf34a97795ad045461fb0abc99e1ab268413ce2 |