File: mkdocs.yml

package info (click to toggle)
pdm 2.2.1%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 2,140 kB
  • sloc: python: 18,313; makefile: 11
file content (94 lines) | stat: -rw-r--r-- 2,111 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
site_name: PDM

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

theme:
  name: material
  palette:
    - scheme: default
      primary: deep purple
      accent: teal
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: teal
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font:
    text: Open Sans
    code: Fira Code
  logo: assets/logo.svg
  favicon: assets/logo.svg
  features:
    - navigation.tabs
    - navigation.tabs.sticky
  custom_dir: overrides

plugins:
  - search
  - mike
  - markdown-exec
  - mkdocstrings:
      handlers:
        python:
          selection:
            docstring_style: google

nav:
  - Usage:
      - Home: index.md
      - usage/project.md
      - usage/venv.md
      - usage/pep582.md
      - usage/dependency.md
      - usage/scripts.md
      - usage/hooks.md
      - usage/advanced.md
      - usage/cli_reference.md
      - usage/configuration.md
  - Writing pyproject.toml:
      - pyproject/pep621.md
      - pyproject/tool-pdm.md
      - pyproject/build.md
  - Plugins:
      - plugin/write.md
      - plugin/reference.md
  - Development:
      - dev/contributing.md
      - dev/changelog.md
      - dev/benchmark.md

markdown_extensions:
  - pymdownx.highlight:
      linenums: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - admonition
  - tables
  - toc:
      permalink: "#"
  - markdown_include.include:
      base_path: docs
  - 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
  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