Initial commit
This commit is contained in:
+142
@@ -0,0 +1,142 @@
|
||||
site_name: Документация
|
||||
site_description: Описание проекта и его компонентов
|
||||
site_author: Иван Иванов
|
||||
copyright: Иван Иванов © 2026, MIT License
|
||||
|
||||
repo_name: Репозиторий
|
||||
repo_url: https://git.axenov.dev/anthony/mkdocs-boilerplate
|
||||
edit_uri: src/branch/master/content/
|
||||
remote_branch: master
|
||||
|
||||
docs_dir: ./content
|
||||
use_directory_urls: false
|
||||
watch:
|
||||
- content
|
||||
- snippets
|
||||
extra_css:
|
||||
- css/custom.css
|
||||
# extra_javascript:
|
||||
# - https://unpkg.com/ionicons@7.1.0/dist/ionicons/ionicons.js
|
||||
|
||||
extra:
|
||||
homepage: /docs
|
||||
logo: assets/img/favicon/logo.png
|
||||
favicon: assets/img/favicon/logo.png
|
||||
social:
|
||||
- name: Telegram
|
||||
icon: simple/telegram
|
||||
link: https://t.me/
|
||||
- name: YouTube
|
||||
icon: simple/youtube
|
||||
link: https://www.youtube.com/
|
||||
alternate:
|
||||
- name: Русский
|
||||
link: /
|
||||
lang: ru
|
||||
- name: English
|
||||
link: /en/
|
||||
lang: en
|
||||
|
||||
theme:
|
||||
name: 'material'
|
||||
language: ru
|
||||
custom_dir: overrides
|
||||
features:
|
||||
- content.action.edit
|
||||
- content.tabs.link
|
||||
- navigation.footer
|
||||
- navigation.indexes
|
||||
- navigation.path
|
||||
- navigation.sections
|
||||
# - navigation.expand
|
||||
- navigation.tabs
|
||||
- navigation.top
|
||||
- navigation.tracking
|
||||
- search.suggest
|
||||
- toc.follow
|
||||
icon:
|
||||
repo: simple/github
|
||||
edit: material/pencil
|
||||
view: material/eye
|
||||
annotation: material/chevron-right-circle
|
||||
palette:
|
||||
# Автотема
|
||||
- media: "(prefers-color-scheme)"
|
||||
toggle:
|
||||
icon: material/brightness-auto
|
||||
name: Включить тёмную тему
|
||||
# Тёмная тема
|
||||
- scheme: slate
|
||||
media: "(prefers-color-scheme: light)"
|
||||
accent: teal
|
||||
primary: black
|
||||
toggle:
|
||||
name: Включить светлую тему
|
||||
icon: material/weather-sunny
|
||||
# Светлая тема
|
||||
- scheme: default
|
||||
media: "(prefers-color-scheme: dark)"
|
||||
accent: teal
|
||||
primary: teal
|
||||
toggle:
|
||||
name: Предпочесть системную тему
|
||||
icon: material/weather-night
|
||||
|
||||
plugins:
|
||||
- minify:
|
||||
minify_html: true
|
||||
- tags:
|
||||
listings: true
|
||||
tags_hierarchy: true
|
||||
tags_hierarchy_separator: /
|
||||
tags_name_property: keywords
|
||||
# shadow: true
|
||||
export: true
|
||||
listings_toc: true
|
||||
- social:
|
||||
cards_layout_options:
|
||||
background_color: teal
|
||||
background_image: null
|
||||
- search:
|
||||
separator: '[\s\-\.]+'
|
||||
# indexing: 'full'
|
||||
|
||||
validation:
|
||||
omitted_files: warn
|
||||
absolute_links: warn
|
||||
unrecognized_links: warn
|
||||
anchors: warn
|
||||
|
||||
markdown_extensions:
|
||||
- admonition
|
||||
- attr_list
|
||||
- md_in_html
|
||||
- footnotes
|
||||
- pymdownx.details
|
||||
- pymdownx.superfences
|
||||
- pymdownx.tasklist:
|
||||
clickable_checkbox: false
|
||||
- pymdownx.snippets:
|
||||
base_path: snippets
|
||||
# auto_append:
|
||||
# - abbr.md
|
||||
- toc:
|
||||
permalink: true
|
||||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
||||
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
||||
options:
|
||||
custom_icons:
|
||||
- overrides/.icons
|
||||
|
||||
nav:
|
||||
- index.md
|
||||
- "Раздел 1":
|
||||
- part1/page1.md
|
||||
- part1/page2.md
|
||||
- "Доп. сведения":
|
||||
- vscode-icons.md # debug
|
||||
- glossary.md
|
||||
- tags.md
|
||||
Reference in New Issue
Block a user