diff --git a/docs/assets/img/basic_template_preview.png b/docs/assets/img/basic_template_preview.png new file mode 100644 index 0000000000000000000000000000000000000000..204ac13e66ce2ec8978012cbd7fa72248328098f Binary files /dev/null and b/docs/assets/img/basic_template_preview.png differ diff --git a/docs/assets/img/custom_template_preview.png b/docs/assets/img/custom_template_preview.png new file mode 100644 index 0000000000000000000000000000000000000000..b43f625c14524ec3e64657c6a6ff413b4882de02 Binary files /dev/null and b/docs/assets/img/custom_template_preview.png differ diff --git a/docs/personal_template/example.md b/docs/personal_template/example.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..db5dd668c107493e9ce67ddb89e6a3ed8072b0fc 100644 --- a/docs/personal_template/example.md +++ b/docs/personal_template/example.md @@ -0,0 +1,38 @@ +{% set curr_repo=subs("mkdocs_template") %} +# Example + +This current documentation you are reading is actually using the custom template +[Mkdocs Template R.Deville][mkdocs_template_rdeville]. + +This custom template add a lots of things such as : + + - `.gitlab-ci.yaml` with basic CI file at the root of the repo to later be + extended and another CI file to only test and build the documentation, + - Workflow files definining some syntax rules such as `.editorconfig`, + `.yamllint`, `pyproject.toml` (which also define basic test using `tox`), + - `README.md`, a template of README which is automatically updated with the + script `post_setup.sh`, + - `mkdocs.yml` with more plugins and more configuration than the basic file. + - A default `docs/_data/vars.yaml` file, + - A complete theme using new plugins defined in `mkdocs.yml` with custom CSS, + javascript, images, etc., + - A predefined basic `docs` content, + - And many more things. + +Below is an example of the rendering of the preview of the basic template and +the custom template. + + +=== "Basic Template" + + ![!Basic Template Preview][basic_template_preview] + + +=== "Custom Template" + + ![!Custom Template Preview][custom_template_preview] + +[mkdocs_template_rdeville]: {{ git_platform.url }}{{ curr_repo.git_slug_with_namespace }}_rdeville +[basic_template_preview]: /assets/img/basic_template_preview.png +[custom_template_preview]: /assets/img/custom_template_preview.png +