From 2c07518ca2c7d0503d308c1ebcd9e32e00473e35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Wed, 10 Feb 2021 21:04:43 +0100 Subject: [PATCH] refactor: Use `pymdownx.snippets` instead of `markdown_include` --- project/docs/changelog.md | 2 +- project/docs/code_of_conduct.md | 2 +- project/docs/contributing.md | 2 +- project/docs/index.md | 2 +- project/docs/license.md | 3 +++ project/mkdocs.yml.jinja | 3 ++- project/pyproject.toml.jinja | 1 - 7 files changed, 9 insertions(+), 6 deletions(-) create mode 100644 project/docs/license.md diff --git a/project/docs/changelog.md b/project/docs/changelog.md index dcdfe2a..90cb31c 100644 --- a/project/docs/changelog.md +++ b/project/docs/changelog.md @@ -1 +1 @@ -{!CHANGELOG.md!} \ No newline at end of file +--8<-- "CHANGELOG.md" \ No newline at end of file diff --git a/project/docs/code_of_conduct.md b/project/docs/code_of_conduct.md index b5d5f94..c2cf022 100644 --- a/project/docs/code_of_conduct.md +++ b/project/docs/code_of_conduct.md @@ -1 +1 @@ -{!CODE_OF_CONDUCT.md!} \ No newline at end of file +--8<-- "CODE_OF_CONDUCT.md" \ No newline at end of file diff --git a/project/docs/contributing.md b/project/docs/contributing.md index 0d1453a..e079654 100644 --- a/project/docs/contributing.md +++ b/project/docs/contributing.md @@ -1 +1 @@ -{!CONTRIBUTING.md!} \ No newline at end of file +--8<-- "CONTRIBUTING.md" \ No newline at end of file diff --git a/project/docs/index.md b/project/docs/index.md index 10882f6..4ab0748 100644 --- a/project/docs/index.md +++ b/project/docs/index.md @@ -1 +1 @@ -{!README.md!} \ No newline at end of file +--8<-- "README.md" \ No newline at end of file diff --git a/project/docs/license.md b/project/docs/license.md new file mode 100644 index 0000000..e34968b --- /dev/null +++ b/project/docs/license.md @@ -0,0 +1,3 @@ +``` +--8<-- "LICENSE" +``` \ No newline at end of file diff --git a/project/mkdocs.yml.jinja b/project/mkdocs.yml.jinja index 63a8a75..5c9b0cf 100644 --- 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 index a34b24d..cbbd3f9 100644 --- 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"