mirror of
https://github.com/astral-sh/ruff
synced 2026-01-20 21:10:48 -05:00
9b43162cc4
## Summary We're planning to move the documentation from [https://beta.ruff.rs/docs](https://beta.ruff.rs/docs) to [https://docs.astral.sh/ruff](https://docs.astral.sh/ruff), for a few reasons: 1. We want to remove the `beta` from the domain, as Ruff is no longer considered beta software. 2. We want to migrate to a structure that could accommodate multiple future tools living under one domain. The docs are actually already live at [https://docs.astral.sh/ruff](https://docs.astral.sh/ruff), but later today, I'll add a permanent redirect from the previous to the new domain. **All existing links will continue to work, now and in perpetuity.** This PR contains the code changes necessary for the updated documentation. As part of this effort, I moved the playground and documentation from my personal Cloudflare account to our team Cloudflare account (hence the new `--project-name` references). After merging, I'll also update the secrets on this repo.
57 lines
1.3 KiB
YAML
57 lines
1.3 KiB
YAML
site_name: Ruff
|
|
theme:
|
|
name: material
|
|
logo: assets/bolt.svg
|
|
favicon: assets/ruff-favicon.png
|
|
features:
|
|
- navigation.instant
|
|
- navigation.instant.prefetch
|
|
- navigation.tracking
|
|
- content.code.annotate
|
|
- toc.integrate
|
|
- toc.follow
|
|
- navigation.path
|
|
- navigation.top
|
|
- content.code.copy
|
|
palette:
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: astral-light
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: astral-dark
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: Switch to light mode
|
|
custom_dir: docs/.overrides
|
|
repo_url: https://github.com/astral-sh/ruff
|
|
repo_name: ruff
|
|
site_author: charliermarsh
|
|
site_url: https://docs.astral.sh/ruff/
|
|
site_dir: site/ruff
|
|
markdown_extensions:
|
|
- 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
|
|
plugins:
|
|
- search
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
extra:
|
|
analytics:
|
|
provider: fathom
|