A MkDocs plugin to filter extra content that was to markdown documents for e.g. formatting docx files.
Project description
mkdocs-word-filter
Strips extra content from markdown files that was added e.g. for converting the files to docx using pandoc
Stripped content can include for example:
-
pagebreaks:
https://github.com/pandocker/pandoc-docx-pagebreak-py
\newpage \toc
Install
python -m pip install mkdocs-word-filter
Usage
Active the plugin in mkdocs.yml
. You can specify the ignorable strings as a list under the filter-lines-with
plugins:
- search
- mkdocs-word-filter:
filter-lines-with:
- \toc
- \newpage
Note: If you have no
plugins
entry in your config file yet, you'll likely also want to add thesearch
plugin. MkDocs enables it by default if there is noplugins
entry set, but now you have to enable it explicitly.
More information about plugins in the MkDocs documentation.
See Also
More information about templates here.
More information about blocks here.
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 mkdocs_word_filter-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | daf199a4efbf5e8effabca5d3b0c80d4c0eb404c68cfd15a17be701eb969d596 |
|
MD5 | e81d867736d5d0a0e9bf84684eb02e43 |
|
BLAKE2b-256 | 99548ab5ad7a97c7fbea1493e3ff13877a200bd5fadf5c8685811f5d81920f63 |