docs/mkdocs.yml
2019-08-12 12:37:39 +02:00

93 lines
1.9 KiB
YAML

# Project information
site_name: api.global - documentation
site_description: high availability API made by lossless
site_author: Lossless GmbH
site_url: https://docs.api.global/
# directories
docs_dir: markdown
site_dir: public
# Repository
repo_name: apiglobal/docs
repo_url:
edit_uri: ""
# Copyright
copyright: 'Copyright © 2016 - 2019 Lossless GmbH'
# Configuration
theme:
name: material
# 404 page
static_templates:
- 404.html
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
feature:
tabs: true
palette:
primary: indigo
accent: indigo
font:
text: Roboto
code: Roboto Mono
favicon: assets/images/favicon.png
logo:
icon: "\uE80C"
# Customization
extra:
social:
- type: globe
link: https://bellini.io
- type: gitlab
link: https://gitlab.com/bellini
- type: twitter
link: https://twitter.com/bellini
# Extensions
markdown_extensions:
- meta
- markdown.extensions.admonition
- markdown.extensions.codehilite:
guess_lang: false
- markdown.extensions.def_list
- markdown.extensions.footnotes
- markdown.extensions.meta
- markdown.extensions.toc:
permalink: true
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:pymdownx.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# Page tree
nav:
- Overview:
- Getting Started: index.md
- NodeJS: nodejs.md
- Support: support.md