Added example for basic configuration

This commit is contained in:
squidfunk 2017-06-20 18:54:46 +02:00 committed by Martin Donath
parent 7d373a128c
commit d85ef155de
3 changed files with 29 additions and 2 deletions

View File

@ -0,0 +1,3 @@
# Example
This is a minimal example configuration.

25
examples/basic/mkdocs.yml Normal file
View File

@ -0,0 +1,25 @@
# Copyright (c) 2016-2017 Martin Donath <martin.donath@squidfunk.com>
# 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

View File

@ -25,7 +25,6 @@ site_name: Example
repo_name: squidfunk/mkdocs-material repo_name: squidfunk/mkdocs-material
repo_url: https://github.com/squidfunk/mkdocs-material repo_url: https://github.com/squidfunk/mkdocs-material
# Reference the original theme and the directory which contains the # Theme and overrides, i.e. language partial
# overrides for the partials, i.e. the language.html.
theme: material theme: material
theme_dir: theme theme_dir: theme