ezops/mkdocs.yml

104 lines
2.0 KiB
YAML

site_name: Ezops 文档
site_description: 运维开发平台
site_author: Logan
site_url: http://localhost:8000
copyright: Copyright @ 2023 Logan Li, All rights reserved.
repo_name: 'Ezops'
repo_url: https://git.opsx.vip/docs/ezops
# theme: mkdocs # 默认主题
# theme: readthedocs
# theme: material # pip3 install mkdocs-material
edit_uri: https://github.com/CloudExplorer-Dev/docs/tree/main/docs
theme:
name: 'material'
logo: './image/logo-white.png'
favicon: './image/favicon.ico'
language: 'zh'
highlightjs: true
hljs_languages:
- yaml
- django
palette:
- scheme: default
accent: blue
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- scheme: slate
accent: blue
toggle:
icon: material/weather-night
name: Switch to light mode
features:
- navigation.instant
- navigation.tracking
- navigation.indexes
- navigation.top
- search.suggest
- search.highlight
- search.share
- header.autohide
- content.tabs.link
custom_dir: "theme"
nav:
- 产品介绍: index.md
- 快速入门: quick_start.md
- 系统架构: system_arch.md
- 作者说明: author.md
markdown_extensions:
- admonition
- codehilite:
guess_lang: True
linenums: False
# - toc:
# permalink: True
- footnotes
- attr_list
- def_list
- tables
- abbr
- md_in_html
- pymdownx.extra
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist
- pymdownx.tilde
- pymdownx.betterem
- pymdownx.progressbar
- pymdownx.tabbed
extra_css:
- css/extra.css
plugins:
- search:
lang:
- en
- ja
separator: '[\s\-\.]+'
extra:
version:
method: mike
social:
- icon: fontawesome/brands/github
link: https://git.opsx.vip/docs/ezops.git
- icon: fontawesome/solid/envelope
link: mailto:admin@attacker.club
# - icon: fontawesome/solid/phone
# link: tel://18072725611