PythonFullStackGuide/mkdocs.yml

137 lines
3.9 KiB
YAML
Raw Permalink Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

nav:
# - 默认页面: index.md
- Python 基础篇:
- Python 入门: python/introduction.md
- 变量和数据类型: python/variables_and_data_types.md
- 控制流程if、else、for、while: python/control_flow.md
- 函数和模块: python/functions_and_modules.md
- 异常处理: python/exception_handling.md
- 第三方常用模块: python/common_modules.md
- Web 基础基:
- HTML: web/frontend_html.md
- CSS: web/frontend_css.md
- JavaScript: web/frontend_js.md
- Web 开发高级篇:
- Vue.js 前端开发:
- Vue.js 简介: web/vue/introduction.md
- Vue.js 基础概念: web/vue/basic_concepts.md
- Vue.js 组件和指令: web/vue/components_and_directives.md
- Vue.js 状态管理 (Vuex): web/vue/vuex.md
- Django 后端开发:
- Django REST framework (DRF) 简介: web/drf/introduction.md
- DRF 序列化器: web/drf/serializers.md
- DRF 视图: web/drf/views.md
- DRF 路由: web/drf/routing.md
- DRF 认证和权限: web/drf/authentication_and_permissions.md
- Django数据库ORM: web/drf/orm.md
- Django数据库操作Queryset: web/drf/queryset.md
- 定时任务和消息队列:
- Celery 异步任务: web/celery_async_tasks.md
- Redis 作为消息队列: web/redis_message_queue.md
site_name: PythonFullStackGuide
site_description: Python 全栈开发
site_author: Logan
site_url: http://localhost:8000
copyright: Copyright @ 2024 Logan Li, All rights reserved.
repo_name: PythonFullStackGuide
repo_url: https://git.opsx.vip/docs/PythonFullStackGuide.git
# theme: mkdocs # 默认主题
# theme: readthedocs
# theme: material # pip3 install mkdocs-material
edit_uri: https://git.opsx.vip/docs/PythonFullStackGuide/src/branch/main/mkdocs.yml
# 自定义 CSS
extra_css:
- css/extra.css
# 主题配置
theme:
name: 'material'
logo: './image/logo.png'
favicon: './image/favicon.ico'
language: 'zh' # 设置语言为中文
# 调色板配置,用于白天/夜晚模式切换
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
# 代码高亮配置
highlightjs: true
hljs_languages:
- sh
- sql
- shell
- bash
- yaml
- python
# Markdown扩展配置
markdown_extensions:
- admonition # 用于在文档中创建提示、注意事项、警告等提示框
- footnotes # 脚注
- meta # 定义元数据通过文章上下文控制如disqus
- pymdownx.caret # 下划线上标
- pymdownx.tilde # 删除线下标
- pymdownx.critic # 增加删除修改高亮注释,可修饰行内或段落
- pymdownx.details # 提示块可折叠
- pymdownx.inlinehilite # 行内代码高亮
- pymdownx.mark # 文本高亮
- pymdownx.smartsymbols # 符号转换
- pymdownx.betterem: # 对加粗和斜体更好的检测
smart_enable: all
- pymdownx.tasklist: # 复选框checklist
custom_checkbox: true
- codehilite: # 用于在Markdown文档中进行代码块的高亮显示
guess_lang: True # 允许尝试猜测代码块的语言类型
linenums: False # 控制是否在代码块旁边显示行号
- toc: # 锚点
permalink: True
# 配置搜索插件
plugins:
- search: # 启用搜索插件
lang: # 搜索支持的语言
- en # 英语
- ja # 日语
separator: '[\s\-\.]+' # 搜索关键词的分隔符正则表达式
# 社交链接
extra:
version:
method: mike
social:
- icon: fontawesome/brands/github
link: https://git.opsx.vip/docs/PythonFullStackGuide.git
# target: _blank
- icon: fontawesome/solid/envelope
link: mailto:admin@attacker.club