mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-09-24 03:18:21 +02:00
88 lines
2.8 KiB
YAML
Executable File
88 lines
2.8 KiB
YAML
Executable File
# 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: squidfunk/mkdocs-material
|
|
repo_url: https://github.com/squidfunk/mkdocs-material
|
|
edit_uri: edit/rework/docs/
|
|
|
|
# Copyright
|
|
copyright: 'Copyright © 2016 Martin Donath'
|
|
|
|
# Documentation and theme
|
|
theme_dir: material
|
|
|
|
# Options
|
|
extra:
|
|
version: 0.2.4
|
|
logo: images/logo.png
|
|
font:
|
|
text: Ubuntu
|
|
mono: Ubuntu Mono
|
|
author:
|
|
github: squidfunk
|
|
twitter: squidfunk
|
|
|
|
# Extensions
|
|
markdown_extensions:
|
|
- markdown.extensions.admonition
|
|
- markdown.extensions.codehilite(guess_lang=false)
|
|
- markdown.extensions.footnotes
|
|
- markdown.extensions.meta
|
|
- markdown.extensions.toc(permalink=true)
|
|
- pymdownx.arithmatex
|
|
- pymdownx.betterem(smart_enable=all)
|
|
- pymdownx.caret
|
|
- pymdownx.critic
|
|
- pymdownx.githubemoji
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.magiclink
|
|
- pymdownx.mark
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.superfences
|
|
- pymdownx.tasklist(custom_checkbox=true)
|
|
- pymdownx.tilde
|
|
|
|
|
|
# Page tree
|
|
pages:
|
|
- Material: index.md
|
|
- Getting started: getting-started.md
|
|
- Extensions:
|
|
- Admonition: extensions/admonition.md
|
|
- Codehilite: extensions/codehilite.md
|
|
- Footnotes: extensions/footnotes.md
|
|
- Metadata: extensions/metadata.md
|
|
- Permalinks: extensions/permalinks.md
|
|
- PyMdown:
|
|
- Overview: extensions/pymdown/overview.md
|
|
- Inline Hilite: extensions/pymdown/inlinehilite.md
|
|
- Arithmatex: extensions/pymdown/arithmatex.md
|
|
- Tasklist: extensions/pymdown/tasklist.md
|
|
- Specimen: specimen.md
|
|
- Customization: customization.md
|
|
- License: license.md
|