mirror of
https://github.com/astral-sh/ruff
synced 2026-01-08 23:24:31 -05:00
c9e02c52a8
## Summary This PR adds a separate configuration file to enable us to turn on [Insiders-only plugins](https://squidfunk.github.io/mkdocs-material/insiders/getting-started/#built-in-plugins). I've turned on the `typeset` plugin which ensures that the settings on the left-hand navigation pane render as code: <img width="1792" alt="Screen Shot 2023-07-05 at 6 27 20 PM" src="https://github.com/astral-sh/ruff/assets/1309177/c93676dd-bb48-417a-9d3b-528bf001e9b7">
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://beta.ruff.rs/docs/
|
|
site_dir: site/docs
|
|
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
|