docs/mkdocs.yml at main · vipm-io/docs · 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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
site_name: Developer Docs
site_url: https://docs.vipm.io
repo_name: vipm-io/docs
edit_uri: edit/main/docs/
repo_url: https://github.com/vipm-io/docs
copyright: Copyright &copy; 2026 VIPM Community Contributors

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.png
  icon:
    edit: material/file-edit-outline
    repo: fontawesome/brands/github

  palette:
    primary: white
    accent: deep orange

  custom_dir: overrides

  features:
    - search.suggest
    - search.highlight
    - search.share

  font:
    text: Roboto

extra:
  homepage: https://vipm.io
  version:
    provider: mike
    default: latest
  social:
    - icon: custom/vipm
      link: https://vipm.io
      name: vipm.io
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/vipm
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/showcase/vi-package-manager/
    - icon: fontawesome/brands/discord
      link: https://discord.gg/uyXwAz4B63

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.snippets:
      base_path: docs/.snippets
      check_paths: true

nav:
  - Home: index.md
  - VIPM Editions: vipm-editions-comparison.md
  - Guides:
    - Software Bill of Materials (SBOM):
      - sbom/index.md
      - sbom/getting-started.md
      - sbom/workflows.md
      - sbom/output-reference.md
      - sbom/custom-components.md
    - Using vipm.toml Files:
      - vipm-toml/index.md
      - vipm-toml/getting-started.md
      - vipm-toml/nipm.md
    - Building Packages:
      - building-packages/index.md
      - building-packages/building-vi-packages-that-depend-on-other-software.md
      - building-packages/vi-packages-build-templates.md
    - Publishing Packages:
      - publishing-packages/index.md
    - Command-Line Interface (CLI):
      - cli/index.md
      - cli/getting-started.md
      - cli/command-reference.md
      - cli/environment-variables.md
      - cli/docker.md
      - cli/github-actions.md
    - VIPM on Linux:
      - linux/index.md
      - linux/ubuntu.md
      - linux/VIPM Linux Crash on Package Installation - Permission Fix.md
  - Release Notes:
    - release-notes/index.md
    - release-notes/2026.3.md
    - release-notes/2026.1.md
    - release-notes/2025.3.1.md
    - release-notes/2025.3.md
    - release-notes/2024.3.md
    - release-notes/2024.1.md
    - release-notes/2023.3.md
    - release-notes/2023.1.md
  - Early Access Preview Releases: preview.md
  - VIPM Platform Security: security/index.md
  - Support: support.md
  - Troubleshooting:
    - troubleshooting/index.md
    - troubleshooting/are-vipms-online-services-down.md