PythonBackendEngineerGuide/mkdocs.yml at main · PY-GZKY/PythonBackendEngineerGuide · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
site_name: Python后端工程师生存指南
site_description: Python后端工程师生存指南
site_author: 梧桐
copyright: 梧桐
site_url: https://fastapi.tplan.cc
repo_url: https://github.com/py-gzky/fastapi-docs
repo_name: py-gzky/fastapi-docs
remote_name: https://github.com/py-gzky/fastapi-docs
remote_branch: site

theme:
  name: 'material'
  features:
    - content.code.annotate
    - content.tabs.link
    - navigation.indexes
    - navigation.instant
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
  language: 'zh'
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: 打开深色模式
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-outline
        name: 关闭深色模式

extra:
  search:
  analytics:
    provider: google
    property: 'UA-111276663-2'

markdown_extensions:
  - admonition
  - codehilite
  - pymdownx.inlinehilite
  - pymdownx.critic
  - toc:
      permalink: false
  - pymdownx.highlight:
      anchor_linenums: true  #代码块行号锚链接，默认false
      use_pygments: true  #在构建期间使用Pygments或在浏览器中使用 JavaScript 语法高亮器进行高亮显示，默认true
      auto_title: true  #自动为所有代码块添加标题，显示正在使用的语言的名称，默认false
      linenums: true #向所有代码块添加行号，默认false
      linenums_style: pymdownx-inline #三种添加行号的方法，建议table或pymdownx-inline。默认table
  - pymdownx.superfences

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/sorts/tablesort.number.min.js

plugins:
  - search:
      separator: '[\s\u200b\-]'
  - git-revision-date-localized:
      enable_creation_date: true

nav:
  - 首页:
      - 首页: README.md
  - 服务器配置:
      - 如何搭建一台后端服务器: how-to-configure-server.md
      - 如何选择数据库服务: how-to-quickly-deploy-database.md
  - Docker部署服务:
      - 如何使用 Docker 部署服务: how-to-deploy-using-docker.md
  - FastAPI框架:
      - 如何快速开发 FastAPI 应用: how-to-quickly-develop-fastapi-application.md
      - 如何快速部署 FastAPI 服务: how-to-deploy-fastapi-services.md
      - 如何集成 FastAPI 插件: how-to-integrate-plugins.md
  - 优化后端性能:
      - 如何优化后端服务: how-to-optimize-performance.md