pixi/mkdocs.yml at main · jayber-devops/pixi · 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
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
site_name: "Pixi by prefix.dev"
site_url: https://prefix-dev.github.io/pixi

theme:
  name: material
  custom_dir: docs/overrides
  favicon: assets/pixi.png
  logo: assets/pixi.png
  font:
    text: Red Hat Text
    code: JetBrains Mono

  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: prefix-light
      accent: prefix-light
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: prefix
      accent: prefix
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  icon:
    edit: material/pencil
    view: material/eye

  features:
    - content.tabs.link
    - content.code.copy
    - content.action.edit
    - content.code.annotate
    - content.tooltips
    # - content.code.select Sponsor only
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.footer

extra_css:
  - stylesheets/extra.css
extra_javascript:
  - javascripts/extra.js

repo_url: https://github.com/prefix-dev/pixi/
edit_uri: edit/main/docs/

markdown_extensions:
  - admonition
  - abbr
  - def_list
  - footnotes
  - attr_list
  - pymdownx.extra
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      toc_depth: 3
      permalink: "#"
  - mdx_truly_sane_lists

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/prefix-dev
    - icon: fontawesome/brands/mastodon
      link: https://hachyderm.io/@prefix
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/prefix.dev
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/prefix-dev
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/prefix_dev
  version:
    provider: mike

nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - First Project: first_project.md
      - Basic Usage: getting_started.md
  - Tutorials:
      - Python:
          - Basic Usage: python/tutorial.md
          - pyproject.toml: python/pyproject_toml.md
          - Pytorch Installation: python/pytorch.md
      - ROS 2: tutorials/ros2.md
      - Rust: tutorials/rust.md
      - Switching From...:
          - Poetry: switching_from/poetry.md
          - Conda/Mamba: switching_from/conda.md
      - Multi Environment: tutorials/multi_environment.md
      - Global Tools: global_tools/introduction.md
  - Concepts:
      - Environments: workspace/environment.md
      - Tasks: workspace/advanced_tasks.md
      - Multi Platform: workspace/multi_platform_configuration.md
      - Multi Environment: workspace/multi_environment.md
      - Lock File: workspace/lockfile.md
      - System Requirements: workspace/system_requirements.md
      - Conda & PyPI: concepts/conda_pypi.md
      - Global Tools:
          - Manifest: global_tools/manifest.md
          - Trampolines: global_tools/trampolines.md
  - Building:
      - Getting Started: build/getting_started.md
      - Tutorials:
          - Building a Python Package: build/python.md
          - Building a C++ Package: build/cpp.md
          - Multiple Packages in Workspace: build/workspace.md
          - Variants: build/variants.md
          - Advanced Building Using rattler-build: build/advanced_cpp.md
      - Dependency Types: build/dependency_types.md
      - Build Backends: build/backends.md
  - Distributing:
      - Pixi Pack: deployment/pixi_pack.md
      - Authentication: deployment/authentication.md
      - Container: deployment/container.md
      - S3: deployment/s3.md
  - Integration:
      - Editor:
          - VSCode: integration/editor/vscode.md
          - Jetbrains: integration/editor/jetbrains.md
          - Zed: integration/editor/zed.md
          - RStudio: integration/editor/r_studio.md
          - JupyterLab: integration/editor/jupyterlab.md
      - Continuous Integration:
          - GitHub Actions: integration/ci/github_actions.md
          - Pixi Diff-to-markdown: integration/ci/updates_github_actions.md
      - Extensions:
          - Introduction: integration/extensions/introduction.md
          - Pixi Diff: integration/extensions/pixi_diff.md
          - Pixi Diff-to-markdown: integration/ci/updates_github_actions.md
          - Pixi Inject: integration/extensions/pixi_inject.md
          - Pixi Install-to-prefix: integration/extensions/pixi_install_to_prefix.md
          - Pixi Pack: deployment/pixi_pack.md
      - Third Party:
          - Direnv: integration/third_party/direnv.md
          - Starship: integration/third_party/starship.md
  - Advanced:
      - Channel Logic: advanced/channel_logic.md
      - Info Command: advanced/explain_info_command.md
      - Shebang: advanced/shebang.md
      - Shell: advanced/pixi_shell.md
  - Reference:
      - Pixi Manifest: reference/pixi_manifest.md
      - Pixi Configuration: reference/pixi_configuration.md
      - CLI: reference/cli/pixi.md
      - Environment Variables: reference/environment_variables.md
  - Misc:
      - Changelog: CHANGELOG.md
      - Pixi Vision: misc/vision.md
      - Packaging Pixi: misc/packaging.md
      - Community: misc/Community.md
      - FAQ: misc/FAQ.md

hooks:
  - schema/docs_hooks.py
  - install/docs_hooks.py
  - docs/docs_hooks.py

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

not_in_nav: |
  reference/cli/
  partials/

plugins:
  - redirects:
      redirect_maps:
        "configuration.md": "reference/pixi_manifest.md"
        "reference/project_configuration.md": "reference/pixi_manifest.md"
        "basic_usage.md": "getting_started.md"
        "tutorials/python.md": "python/tutorial.md"
        "features/environment.md": "workspace/environment.md"
        "features/advanced_tasks.md": "workspace/advanced_tasks.md"
        "features/multi_platform_configuration.md": "workspace/multi_platform_configuration.md"
        "features/multi_environment.md": "workspace/multi_environment.md"
        "features/lockfile.md": "workspace/lockfile.md"
        "features/system_requirements.md": "workspace/system_requirements.md"
        "features/global_tools.md": "global_tools/introduction.md"
        "features/pytorch.md": "python/pytorch.md"
        "ide_integration/jupyterlab.md": "integration/editor/jupyterlab.md"
        "ide_integration/pycharm.md": "integration/editor/jetbrains.md"
        "ide_integration/r_studio.md": "integration/editor/r_studio.md"
        "ide_integration/devcontainer.md": "integration/editor/vscode.md"
        "advanced/authentication.md": "deployment/authentication.md"
        "advanced/channel_priority.md": "advanced/channel_logic.md"
        "advanced/github_actions.md": "integration/ci/github_actions.md"
        "advanced/updates_github_actions.md": "integration/ci/updates_github_actions.md"
        "advanced/lockfile_diffs.md": "integration/extensions/pixi_diff.md"
        "advanced/production_deployment.md": "deployment/container.md"
        "advanced/pyproject_toml.md": "python/pyproject_toml.md"
        "advanced/s3.md": "deployment/s3.md"
        "advanced/third_party.md": "integration/third_party/starship.md"
        "reference/cli.md": "reference/cli/pixi.md"
        "vision.md": "misc/vision.md"
        "packaging.md": "misc/packaging.md"
        "Community.md": "misc/Community.md"
        "FAQ.md": "misc/FAQ.md"
        "integration/editor/devcontainer.md": "integration/editor/vscode.md"
        "integration/editor/pycharm.md": "integration/editor/jetbrains.md"
        "advanced/installation.md": "installation.md"

  - search
  - social
  - mike:
    # These fields are all optional; the defaults are as below...
    # alias_type: symlink
    # redirect_template: null
    # deploy_prefix: ''
    # canonical_version: null
    # version_selector: true
    # css_dir: css
    # javascript_dir: js