Skip to main content

A MkDocs plugin to filter extra content that was to markdown documents for e.g. formatting docx files.

Project description

mkdocs-docx-content-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:

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 
    - markdown-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 the search plugin. MkDocs enables it by default if there is no plugins 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-word-filter-0.1.0.tar.gz (2.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_word_filter-0.1.0-py3-none-any.whl (3.2 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs-word-filter-0.1.0.tar.gz.

File metadata

  • Download URL: mkdocs-word-filter-0.1.0.tar.gz
  • Upload date:
  • Size: 2.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.5

File hashes

Hashes for mkdocs-word-filter-0.1.0.tar.gz
Algorithm Hash digest
SHA256 dd86254455f83d3a4f89f8070b01d6cea32408e84c3b3619be138970da25f411
MD5 887070ed1131b094a2773fa67a8bd90c
BLAKE2b-256 f7002336628f4a746932a327a6a75dd85283d4a0178fae977fb3aa3f89f57276

See more details on using hashes here.

File details

Details for the file mkdocs_word_filter-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: mkdocs_word_filter-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.5

File hashes

Hashes for mkdocs_word_filter-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fff4d4eea6ca9d0440a52e82efd0e32080227f015e9cfb7f0a03755e490f21c0
MD5 e152ce90a175f9370c24e53065dc83ad
BLAKE2b-256 cd6d9a4a6b36869963e40db0535a6dbb2681a0c201a270ebb369d6c0af0ab762

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page