Skip to content

Commit

Permalink
Remove include-markdown in webdoc, since it crashed readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
Laurent Franceschetti committed Oct 16, 2023
1 parent 2161dd4 commit 428a015
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ INFO - Building documentation...
```
Within the browser (e.g. http://127.0.0.1:8000/info), you should
see a description of the plugins environment:
see a description of the plugin's environment:
![macros_info()](macros_info.png)
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# Initialization
# --------------------

VERSION_NUMBER = '1.0.4'
VERSION_NUMBER = '1.0.5'

# required if you want to run document/test
# pip install 'mkdocs-macros-plugin[test]'
Expand Down
4 changes: 2 additions & 2 deletions webdoc/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Mkdocs-Macros
static website generator, with the use of variables and macros. **

!!! Tip "A mini-framework"
mkdocs-macros is more than a "plugin". It is a **mini-framework**
Mkdocs-Macros is more than a "plugin". It is a **mini-framework**
developped with one goal in mind:

**To enhance mkdocs with the macro and automation capabilities
Expand Down Expand Up @@ -34,7 +34,7 @@ that:
The capabilities of **mkdocs-macros-plugin** are so wide
that it can be called a **"mini-framework"**.

**mkdocs-macros-plugin** is very easy to use **out of the box**,
**Mkdocs-Macros** is very easy to use **out of the box**,
even for small documentation projects: it provides
data about the platform, the git repository (if any), etc.

Expand Down
6 changes: 2 additions & 4 deletions webdoc/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,7 @@ plugins:
# 1. a question of "boostrap" (avoid chicken and the egg issues)
# 2. avoid interpreting the jinja2 code examples as instructions.
- search
- include-markdown
- mermaid2:
arguments:
securityLevel: 'loose'
# - include-markdown
- mermaid2


0 comments on commit 428a015

Please sign in to comment.