Back to Pixi

README

docs/reference/cli/__README.md

0.76.2707 B
Original Source

This directory contains the autogenerated CLI documentation, generated by pixi run generate-cli-docs.

Commands without subcommands get a <command>.md file. Commands with subcommands get the index.md of the directory holding their subcommand pages, which navigation.indexes renders as a clickable section header.

Each autogenerated file injects snippets named description and example from a hand-written <command>_extender file next to it. For example, docs/reference/cli/pixi/add.md is the autogenerated file and docs/reference/cli/pixi/add_extender is the injecting file.

Snippet documentation can be found here: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/