Metadata-Version: 2.1
Name: mkdocs_include_markdown_plugin
Version: 0.1.0
Summary: Mkdocs Markdown includer plugin.
Home-page: https://github.com/mondeja/mkdocs-include-markdown-plugin
Author: Joe Rickerby
License: UNKNOWN
Project-URL: Documentation, https://github.com/mondeja/mkdocs-include-markdown-plugin
Project-URL: Source, https://github.com/mondeja/mkdocs-include-markdown-plugin
Project-URL: Issue Tracker, https://github.com/mondeja/mkdocs-include-markdown-plugin/issues
Description: 
        # mkdocs-include-markdown-plugin
        
        Mkdocs Markdown includer plugin.
        
        ## Status
        
        [![PyPI][pypi-version-badge-link]][pypi-link]
        [![Tests][tests-image]][tests-link]
        [![Coverage status][coverage-image]][coverage-link]
        
        ## Installation
        
        ```bash
        pip install mkdocs-include-markdown-plugin
        ```
        
        ## Documentation
        
        ### Setup
        
        Enable the plugin in your `mkdocs.yml`:
        
        ```
        plugins:
          - include-markdown
        ```
        
        ### Directives
        
        This plugin includes two directives, one to include markdown files and another
        to include files of any type:
        
        
        #### **`include-markdown`**
        
        Includes markdown file content, optionally using two delimiters to filter the
        content to include.
        
        - **start** Delimiter that marks the beginning of the content to include.
        - **end** Delimiter that marks the end of the content to include.
        
        ##### Example
        
        ```
        {%
           include-markdown "../README.md"
           start="<!--intro-start-->"
           end="<!--intro-end-->"
        %}
        ```
        
        #### **`include`**
        
        Includes arbitrary file content.
        
        ##### Example
        
        ~~~
        ```yaml
        {% include "../examples/github-minimal.yml" %}
        ```
        ~~~
        
        ## Acknowledgment
        
        - Joe Rickerby and contributors for
         [giving me the permissions][cibuildwheel-470] to separate this plugin from the
         documentation of [cibuildwheel][cibuildwheel-repo-link].
        
        [pypi-link]: https://pypi.org/project/mkdocs-include-markdown-plugin
        [pypi-version-badge-link]: https://img.shields.io/pypi/v/mkdocs-include-markdown-plugin
        [tests-image]: https://img.shields.io/github/workflow/status/mondeja/mkdocs-include-markdown-plugin/CI?logo=github
        [tests-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/actions?query=workflow%3ACI
        [coverage-image]: https://img.shields.io/coveralls/github/mondeja/mkdocs-include-markdown-plugin?logo=coveralls
        [coverage-link]: https://coveralls.io/github/mondeja/mkdocs-include-markdown-plugin
        
        [cibuildwheel-470]:https://github.com/joerick/cibuildwheel/issues/470
        [cibuildwheel-repo-link]: https://github.com/joerick/cibuildwheel
        
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Documentation
Classifier: Topic :: Text Processing
Classifier: Topic :: Text Processing :: Markup :: Markdown
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
