refactor: Use pymdownx.snippets instead of markdown_include

pawamoy · Feb 10, 2021 · 2c07518 · 2c07518
1 parent 9c3f29d
commit 2c07518
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 6 deletions.
diff --git a/project/docs/changelog.md b/project/docs/changelog.md
@@ -1 +1 @@
-{!CHANGELOG.md!}
+--8<-- "CHANGELOG.md"
diff --git a/project/docs/code_of_conduct.md b/project/docs/code_of_conduct.md
@@ -1 +1 @@
-{!CODE_OF_CONDUCT.md!}
+--8<-- "CODE_OF_CONDUCT.md"
diff --git a/project/docs/contributing.md b/project/docs/contributing.md
@@ -1 +1 @@
-{!CONTRIBUTING.md!}
+--8<-- "CONTRIBUTING.md"
diff --git a/project/docs/index.md b/project/docs/index.md
@@ -1 +1 @@
-{!README.md!}
+--8<-- "README.md"
diff --git a/project/docs/license.md b/project/docs/license.md
@@ -0,0 +1,3 @@
+```
+--8<-- "LICENSE"
+```
diff --git a/project/mkdocs.yml.jinja b/project/mkdocs.yml.jinja
@@ -25,9 +25,10 @@ extra_css:
 
 markdown_extensions:
 - admonition
-- markdown_include.include
 - pymdownx.emoji
 - pymdownx.magiclink
+- pymdownx.snippets:
+    check_paths: true
 - pymdownx.superfences
 - pymdownx.tabbed
 - pymdownx.tasklist

diff --git a/project/pyproject.toml.jinja b/project/pyproject.toml.jinja
@@ -37,7 +37,6 @@ ipython = "^7.2"
 # TODO: accept v5 once https://github.com/wemake-services/wemake-python-styleguide/issues/1584 is resolved
 isort = {version = "<5", extras = ["pyproject"]}
 jinja2-cli = "^0.7.0"
-markdown-include = "^0.6.0"
 mkdocs = "^1.1.2"
 mkdocs-material = "^6.2.7"
 mkdocstrings = "^0.14.0"