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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

Supported by

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