Skip to main content

MkDocs Plugin to render other foramt files.

Project description

PyPI - Python Version PyPI PyPI - Downloads GitHub contributors PyPI - License

mkdocs-render-otherfile-plugin

MkDocs plugin to render other format files in mkdocs build. This only affects your rendered HTML and does not affect the markdown files.

Setup

Install the plugin using pip3:

pip3 install mkdocs-render-otherfile-plugin

Next, add the following lines to your mkdocs.yml:

plugins:
  - search
  - render-otherfile

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.

Usage

Example of multiple options set in the mkdocs.yml file:

plugins:
    - search
    - render-otherfile
        ext:
            - .c
            - .cpp
            - .py

Options

  • ext: files ext render in mkdocs build process.

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-render-otherfile-plugin-1.0.0.tar.gz (2.9 kB view details)

Uploaded Source

Built Distribution

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

mkdocs_render_otherfile_plugin-1.0.0-py2.py3-none-any.whl (4.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file mkdocs-render-otherfile-plugin-1.0.0.tar.gz.

File metadata

  • Download URL: mkdocs-render-otherfile-plugin-1.0.0.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.3

File hashes

Hashes for mkdocs-render-otherfile-plugin-1.0.0.tar.gz
Algorithm Hash digest
SHA256 7e18102a0233a9eb643ace2f3469dcb687b9d6e9cadc092b7e9688984ddd601d
MD5 32469e7699e920dea70babec8343a8fc
BLAKE2b-256 de82f2a1e97ad71ef149c342e8deaeaedc59980b8ec9f9549d1c3b48f895f2bf

See more details on using hashes here.

File details

Details for the file mkdocs_render_otherfile_plugin-1.0.0-py2.py3-none-any.whl.

File metadata

  • Download URL: mkdocs_render_otherfile_plugin-1.0.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.3

File hashes

Hashes for mkdocs_render_otherfile_plugin-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 68b52f58a55bd2c815078412c21ad1beed34da6bd8b43a0188ab5ae2f8339376
MD5 21fe5c4b684b59371e8b02cd611dfaa0
BLAKE2b-256 051338e46b4f0cbcdee7d889feef5d177a32fad99ab2e7ac86389df7a0112130

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