Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -250,3 +250,51 @@ plugins:
# version_selector: true
# css_dir: css
# javascript_dir: js
# llmstxt must come after the mike plugin:
- llmstxt:
enabled: true
full_output: llms-full.txt
markdown_description: |-
Pixi is a fast, modern, and reproducible package management tool
for developers of all backgrounds. Pixi is a cross-platform package manager
and project management tool that creates reproducible environments using conda and PyPI packages.

To use Pixi, start by running `pixi init my_project` to create a new project with a `pixi.toml` manifest file,
then add dependencies using `pixi add package1 package2 ...` for conda packages
or `pixi add --pypi python_package ...` for PyPI packages. Pixi automatically generates a lockfile (`pixi.lock`)
to ensure reproducible environments across different systems.
You can define and run tasks using `pixi task add task_name "command arg1 arg2"` and `pixi run task_name`,
and work within the project's virtual environment using `pixi run` for single commands
or `pixi shell` for an interactive session.

The tool combines dependency management, task running, and environment isolation in a single workflow,
making it easy to share consistent development environments with others. See other documentation sections
for further details on how to use the software.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@baszalmstra I've expanded this section a bit on quick start with pixi. Please let me know if there are any inaccuracies. This example inspired me to expand this: https://github.com/astral-sh/uv/blob/785595bd35790154098beab422662862d655adde/mkdocs.template.yml#L85-L92

sections:
Getting Started documentation:
- index.md
- installation.md
- getting_started.md
- first_project.md
Tutorials documentation:
- python/*.md
- tutorials/*.md
- switching_from/*.md
- global_tools/introduction.md
Concepts documentation:
- workspace/*.md
- global_tools/manifest.md
- global_tools/trampolines.md
Building documentation:
- build/*.md
Distributing documentation:
- deployment/*.md
Integration documentation:
- integration/**/*.md
Advanced documentation:
- advanced/*.md
Reference documentation:
- reference/*.md
Miscellaneous documentation:
- CHANGELOG.md
- misc/*.md
Loading
Loading