mkdocs-material/mkdocs.yml

86 lines
2.7 KiB
YAML
Raw Normal View History

2016-02-04 17:03:20 +03:00
# 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
2016-02-09 23:59:37 +03:00
site_name: Material
2016-02-04 17:03:20 +03:00
site_description: A material design theme for MkDocs
site_author: Martin Donath
2016-02-09 23:59:37 +03:00
site_url: http://squidfunk.github.io/mkdocs-material/
2016-02-04 17:03:20 +03:00
# Repository
2016-09-23 12:56:25 +03:00
repo_name: squidfunk/mkdocs-material
2016-02-09 14:58:55 +03:00
repo_url: https://github.com/squidfunk/mkdocs-material
2016-02-04 17:03:20 +03:00
# Copyright
2016-08-07 19:01:56 +03:00
copyright: 'Copyright &copy 2016 Martin Donath'
2016-02-04 17:03:20 +03:00
# Documentation and theme
2016-02-09 14:58:55 +03:00
theme_dir: material
2016-02-04 17:03:20 +03:00
2016-02-09 23:59:37 +03:00
# Options
2016-02-04 17:03:20 +03:00
extra:
2016-08-07 19:01:56 +03:00
version: 0.2.4
2016-02-09 23:59:37 +03:00
logo: images/logo.png
2016-08-07 19:01:56 +03:00
font:
text: Ubuntu
mono: Ubuntu Mono
2016-02-04 17:03:20 +03:00
author:
github: squidfunk
twitter: squidfunk
# Extensions
markdown_extensions:
2016-09-23 12:56:25 +03:00
- markdown.extensions.admonition
- markdown.extensions.codehilite(guess_lang=false)
2016-09-23 12:56:25 +03:00
- markdown.extensions.footnotes
- markdown.extensions.meta
2016-11-02 21:21:14 +03:00
- markdown.extensions.toc(permalink=true)
2016-12-15 17:55:40 +03:00
- pymdownx.arithmatex
- pymdownx.betterem(smart_enable=all)
2016-11-02 21:21:14 +03:00
- pymdownx.caret
- pymdownx.critic
2016-12-15 17:55:40 +03:00
- pymdownx.githubemoji
2016-11-02 21:21:14 +03:00
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
2016-11-02 21:21:14 +03:00
- pymdownx.tasklist(custom_checkbox=true)
- pymdownx.tilde
2016-02-04 17:03:20 +03:00
# Page tree
pages:
2016-02-09 23:59:37 +03:00
- Material: index.md
- Getting started: getting-started.md
2016-09-02 23:59:14 +03:00
- Extensions:
- Admonition: extensions/admonition.md
- Codehilite: extensions/codehilite.md
- Footnotes: extensions/footnotes.md
2016-11-02 21:21:14 +03:00
- Metadata: extensions/metadata.md
2016-09-02 23:59:14 +03:00
- Permalinks: extensions/permalinks.md
2016-11-02 21:21:14 +03:00
- PyMdown:
- Overview: extensions/pymdown/overview.md
2016-12-15 17:55:40 +03:00
- Arithmatex: extensions/pymdown/arithmatex.md
- Tasklist: extensions/pymdown/tasklist.md
2016-08-07 19:01:56 +03:00
- Specimen: specimen.md
2016-02-09 23:59:37 +03:00
- Customization: customization.md
- License: license.md