uv/mkdocs.template.yml
Charlie Marsh 545bbf9286
Add settings.md to docs (#5091)
## Summary

It's kinda messed up: the depths are off, and the titles are incorrectly
uppercased, but I'll fix those tomorrow.

![Screenshot 2024-07-15 at 10 38
50 PM](https://github.com/user-attachments/assets/3aabae67-4d6b-40e1-9523-2d4d1b7006b4)
2024-07-16 02:46:21 +00:00

106 lines
3.1 KiB
YAML

site_name: uv
theme:
name: material
favicon: assets/favicon.ico
features:
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.expand
- navigation.tracking
- content.code.annotate
- toc.integrate
- toc.follow
- navigation.path
- navigation.top
- content.code.copy
- content.tabs.link
palette:
# Note: Using the system theme works with the insiders version
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#automatic-light-dark-mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: astral-light
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: astral-dark
toggle:
icon: material/brightness-4
name: Switch to system preference
custom_dir: docs/.overrides
repo_url: https://github.com/astral-sh/uv
repo_name: uv
site_author: charliermarsh
site_url: https://docs.astral.sh/uv/
site_dir: site/uv
markdown_extensions:
- admonition
- pymdownx.details
- toc:
permalink: "#"
- pymdownx.snippets:
- pymdownx.magiclink:
- attr_list:
- md_in_html:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite:
- pymdownx.superfences:
- markdown.extensions.attr_list:
- pymdownx.keys:
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.tabbed:
alternate_style: true
plugins:
- search
- typeset
extra_css:
- stylesheets/extra.css
extra:
analytics:
provider: fathom
nav:
- Introduction: index.md
- Getting started:
- Installation: installation.md
- First steps: first-steps.md
- Guides:
- Installing Python: guides/install-python.md
- Running scripts: guides/scripts.md
- Using tools: guides/tools.md
- Creating a project: guides/projects.md
- Concepts:
- Projects: preview/projects.md
- Command-line tools: preview/tools.md
- Python versions: python-versions.md
- Workspaces: preview/workspaces.md
- Dependency sources: preview/dependencies.md
- Resolution: resolution.md
- Caching: cache.md
- Authentication: configuration/authentication.md
- Configuration:
- Configuration files: configuration/files.md
- Environment variables: configuration/environment.md
- Settings: settings.md
- Integration guides:
- Using in Docker: guides/docker.md
- Using in GitHub Actions: guides/github.md
- Using in pre-commit: guides/pre-commit.md
- Low-level operations:
- Using environments: pip/environments.md
- Managing packages: pip/packages.md
- Inspecting packages: pip/inspection.md
- Declaring dependencies: pip/dependencies.md
- Locking environments: pip/compile.md
- Policies:
- Versioning: versioning.md
- Platform support: platforms.md
- Compatibility with pip: pip/compatibility.md