Metadata-Version: 2.1
Name: mkdocs-render-otherfile-plugin
Version: 1.0.0
Summary: MkDocs Plugin to render other foramt files.
Home-page: https://github.com/FF1204/mkdocs-rendor-otherfile-plugin.git
Author: FF1204
Author-email: 120406191@qq.com
License: MIT
Keywords: mkdocs index rendor other file plugin
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Requires-Dist: mkdocs (>=1.1)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-add-number-plugin)
![PyPI](https://img.shields.io/pypi/v/mkdocs-add-number-plugin)
![PyPI - Downloads](https://img.shields.io/pypi/dm/mkdocs-add-number-plugin)
![GitHub contributors](https://img.shields.io/github/contributors/timvink/mkdocs-add-number-plugin)
![PyPI - License](https://img.shields.io/pypi/l/mkdocs-add-number-plugin)

# mkdocs-render-otherfile-plugin

[MkDocs](https://www.mkdocs.org/) 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:

```bash
pip3 install mkdocs-render-otherfile-plugin
```

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

```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:

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

## Options

- `ext`: files ext render in mkdocs build process.

