From d85ef155ded10bf1cbe5f3b3c067f29ac718875e Mon Sep 17 00:00:00 2001 From: squidfunk Date: Tue, 20 Jun 2017 18:54:46 +0200 Subject: [PATCH] Added example for basic configuration --- examples/basic/docs/index.md | 3 +++ examples/basic/mkdocs.yml | 25 +++++++++++++++++++++++++ examples/language/mkdocs.yml | 3 +-- 3 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 examples/basic/docs/index.md create mode 100644 examples/basic/mkdocs.yml diff --git a/examples/basic/docs/index.md b/examples/basic/docs/index.md new file mode 100644 index 000000000..425901a57 --- /dev/null +++ b/examples/basic/docs/index.md @@ -0,0 +1,3 @@ +# Example + +This is a minimal example configuration. diff --git a/examples/basic/mkdocs.yml b/examples/basic/mkdocs.yml new file mode 100644 index 000000000..29d6526d1 --- /dev/null +++ b/examples/basic/mkdocs.yml @@ -0,0 +1,25 @@ +# Copyright (c) 2016-2017 Martin Donath + +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: + +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. + +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. + +# Project information +site_name: Example + +# Theme +theme: material diff --git a/examples/language/mkdocs.yml b/examples/language/mkdocs.yml index 5e9663e75..80cc2805c 100644 --- a/examples/language/mkdocs.yml +++ b/examples/language/mkdocs.yml @@ -25,7 +25,6 @@ site_name: Example repo_name: squidfunk/mkdocs-material repo_url: https://github.com/squidfunk/mkdocs-material -# Reference the original theme and the directory which contains the -# overrides for the partials, i.e. the language.html. +# Theme and overrides, i.e. language partial theme: material theme_dir: theme