diff --git a/README.md b/README.md index 4245200..6982282 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,14 @@ import markdown html = markdown.markdown(source, extensions=['markdown_include.include']) ``` +Markdown-Include can also be included in MkDocs projects like below: + +```yaml +markdown_extensions: + - markdown_include.include: + base_path: docs +``` + The syntax for use within your Markdown files is ``{!filename!}``. This statement will be replaced by the contents of ``filename``. Markdown-Include will work recursively, so any included files within ``filename`` will also be