1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-09-24 03:18:21 +02:00
mkdocs-material/mkdocs.yml

103 lines
3.1 KiB
YAML
Raw Normal View History

2017-01-06 19:11:18 +01:00
# Copyright (c) 2016-2017 Martin Donath <martin.donath@squidfunk.com>
2016-02-04 15:03:20 +01:00
# 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
2016-12-28 16:20:52 +01:00
site_name: Material for MkDocs
2017-01-12 20:15:30 +01:00
site_description: A Material Design theme for MkDocs
2016-02-04 15:03:20 +01:00
site_author: Martin Donath
2016-02-09 21:59:37 +01:00
site_url: http://squidfunk.github.io/mkdocs-material/
2016-02-04 15:03:20 +01:00
# Repository
2016-09-23 11:56:25 +02:00
repo_name: squidfunk/mkdocs-material
2016-02-09 12:58:55 +01:00
repo_url: https://github.com/squidfunk/mkdocs-material
2016-02-04 15:03:20 +01:00
# Copyright
2017-01-14 19:48:00 +01:00
copyright: 'Copyright &copy; 2016 - 2017 Martin Donath'
2016-02-04 15:03:20 +01:00
# Theme directory
2016-02-09 12:58:55 +01:00
theme_dir: material
2016-02-04 15:03:20 +01:00
2016-02-09 21:59:37 +01:00
# Options
2016-02-04 15:03:20 +01:00
extra:
language: en
feature:
tabs: false
2016-12-17 12:53:24 +01:00
palette:
primary: indigo
accent: indigo
social:
- type: globe
link: http://struct.cc
- type: github-alt
link: https://github.com/squidfunk
- type: twitter
link: https://twitter.com/squidfunk
- type: linkedin
2017-07-20 14:32:02 +02:00
link: https://linkedin.com/in/squidfunk
2016-02-04 15:03:20 +01:00
# Extensions
markdown_extensions:
2016-09-23 11:56:25 +02:00
- markdown.extensions.admonition
2017-10-20 09:37:18 +02:00
- markdown.extensions.codehilite:
guess_lang: false
2017-02-19 16:11:01 +01:00
- markdown.extensions.def_list
2016-09-23 11:56:25 +02:00
- markdown.extensions.footnotes
- markdown.extensions.meta
2017-10-20 09:37:18 +02:00
- markdown.extensions.toc:
permalink: true
2016-12-15 15:55:40 +01:00
- pymdownx.arithmatex
2017-10-20 09:37:18 +02:00
- pymdownx.betterem:
smart_enable: all
2016-11-02 19:21:14 +01:00
- pymdownx.caret
- pymdownx.critic
2017-08-29 08:17:26 +02:00
- pymdownx.details
2017-01-09 22:25:15 +01:00
- pymdownx.emoji:
emoji_generator: !!python/name:pymdownx.emoji.to_svg
2016-11-02 19:21:14 +01:00
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
2017-10-20 09:37:18 +02:00
- pymdownx.tasklist:
custom_checkbox: true
2016-11-02 19:21:14 +01:00
- pymdownx.tilde
2016-02-04 15:03:20 +01:00
# Page tree
pages:
2016-02-09 21:59:37 +01:00
- Material: index.md
- Getting started: getting-started.md
2016-09-02 22:59:14 +02:00
- Extensions:
- Admonition: extensions/admonition.md
2017-01-09 23:55:04 +01:00
- CodeHilite: extensions/codehilite.md
2016-09-02 22:59:14 +02:00
- Footnotes: extensions/footnotes.md
- Metadata: extensions/metadata.md
2016-09-02 22:59:14 +02:00
- Permalinks: extensions/permalinks.md
- PyMdown: extensions/pymdown.md
2016-08-07 18:01:56 +02:00
- Specimen: specimen.md
2016-02-09 21:59:37 +01:00
- Customization: customization.md
2017-01-09 21:41:30 +01:00
- Release notes: release-notes.md
- Contributing: contributing.md
- License: license.md
# Google Analytics
google_analytics:
- !!python/object/apply:os.getenv ["GOOGLE_ANALYTICS_KEY"]
- auto