File: mkdocs.yml

package info (click to toggle)
pdm 2.26.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,664 kB
  • sloc: python: 26,438; sh: 314; javascript: 34; makefile: 26
file content (142 lines) | stat: -rw-r--r-- 3,582 bytes parent folder | download
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
site_name: PDM

repo_url: https://github.com/pdm-project/pdm
edit_uri: edit/main/docs

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - scheme: default
      media: "(prefers-color-scheme: light)"
      primary: deep purple
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      primary: deep purple
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  font:
    text: Open Sans
    code: Fira Code
  logo: assets/logo.svg
  favicon: assets/logo.svg
  features:
    - content.code.copy
    - navigation.tabs
    - navigation.tabs.sticky
  custom_dir: docs/overrides

plugins:
  - search
  - markdown-exec
  - "mkdocs-version-annotations":
      version_added_admonition: "tip"
  - mkdocstrings:
      enable_inventory: true
      handlers:
        python:
          options:
            docstring_style: google
  - redirects:
      redirect_maps:
        'plugin/fixtures.md': 'dev/fixtures.md'
        'plugin/write.md': 'dev/write.md'
        'pyproject/build.md': 'reference/build.md'
        'plugin/reference.md': 'reference/api.md'
        'usage/cli_reference.md': 'reference/cli.md'
        'usage/configuration.md': 'reference/configuration.md'
        'pyproject/pep621.md': 'reference/pep621.md'

nav:
  - Usage:
      - Introduction: index.md
      - usage/project.md
      - usage/dependency.md
      - Lock Files:
        - usage/lockfile.md
        - usage/lock-targets.md
      - usage/uv.md
      - usage/publish.md
      - usage/config.md
      - usage/scripts.md
      - usage/hooks.md
      - usage/advanced.md
      - usage/venv.md
      - usage/pep582.md
      - usage/template.md
  - Reference:
      - reference/pep621.md
      - reference/configuration.md
      - reference/build.md
      - reference/cli.md
      - reference/api.md
  - Development:
      - dev/write.md
      - dev/fixtures.md
      - dev/contributing.md
      - dev/changelog.md
      - dev/benchmark.md
  - Sponsor: https://github.com/sponsors/pdm-project

markdown_extensions:
  - pymdownx.highlight:
      linenums: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.snippets:
      restrict_base_path: false
  - admonition
  - tables
  - toc:
      permalink: "#"
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

copyright: Copyright &copy; 2019 <a href="https://frostming.com">Frost Ming</a>

extra:
  version:
    provider: mike
  analytics:
    provider: google
    property: G-RP4PM5PGLN
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pdm-project/pdm
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/pdm_project
    - icon: fontawesome/brands/discord
      link: https://discord.gg/Phn8smztpv
  chatbot:
    url: https://2prxfnwkygf4vexczrbpcq.streamlit.app/?embed=true
  alternate:
    - name: '🇬🇧 English'
      link: /en/
      lang: en
    - name: '🇨🇳 简体中文'
      link: /zh-cn/
      lang: zh
extra_css:
  - assets/extra.css
extra_javascript:
  - assets/extra.js

watch:
  - src