summaryrefslogtreecommitdiff
path: root/mkdocs-material/mkdocs.yml
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2016-07-24 19:13:40 -0400
committerJordan Wiens <jordan@psifertex.com>2016-07-24 19:13:40 -0400
commitb1900d6ebcc39738885f90fa9f18b28206a74947 (patch)
tree2d4975fe0a347af7101200c48e4a8df82ca780ae /mkdocs-material/mkdocs.yml
parent754ea372c66afad144988fcab2d7cf1fdbb3f2fc (diff)
very early checkin of template for user-docs, only a few pages filled out
Diffstat (limited to 'mkdocs-material/mkdocs.yml')
-rwxr-xr-xmkdocs-material/mkdocs.yml59
1 files changed, 59 insertions, 0 deletions
diff --git a/mkdocs-material/mkdocs.yml b/mkdocs-material/mkdocs.yml
new file mode 100755
index 00000000..718d73c9
--- /dev/null
+++ b/mkdocs-material/mkdocs.yml
@@ -0,0 +1,59 @@
+# Copyright (c) 2016 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: Material
+site_description: A material design theme for MkDocs
+site_author: Martin Donath
+site_url: http://squidfunk.github.io/mkdocs-material/
+
+# Repository
+repo_name: GitHub
+repo_url: https://github.com/squidfunk/mkdocs-material
+
+# Copyright
+copyright: Copyright (c) 2016 Martin Donath
+
+# Documentation and theme
+theme_dir: material
+
+# Options
+extra:
+ version: 0.2.4
+ logo: images/logo.png
+ github:
+ download_release: true
+ author:
+ github: squidfunk
+ twitter: squidfunk
+
+# Extensions
+markdown_extensions:
+ - codehilite(css_class=code)
+ - admonition
+ - toc:
+ permalink: '#'
+
+# Page tree
+pages:
+ - Material: index.md
+ - Getting started: getting-started.md
+ - Customization: customization.md
+ - License: license.md \ No newline at end of file