Skip to content

Commit

Permalink
Add MkDocs usage to README
Browse files Browse the repository at this point in the history
Contribution from @itopaloglu83
  • Loading branch information
ZedThree committed Nov 23, 2022
1 parent 9c80d50 commit 53f5e3c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 53f5e3c

Please # to comment.