Repository navigation
Expand file tree
/
Copy pathmkdocs.template.yml
More file actions
128 lines (126 loc) · 3.6 KB
/
Copy pathmkdocs.template.yml
File metadata and controls
128 lines (126 loc) · 3.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
site_name: Ruff
theme:
name: material
logo: assets/bolt.svg
favicon: assets/favicon.ico
features:
- navigation.instant
- navigation.instant.prefetch
- 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/ruff
repo_name: ruff
site_author: charliermarsh
site_url: https://docs.astral.sh/ruff/
site_dir: site/ruff
site_description: An extremely fast Python linter and code formatter, written in Rust.
markdown_extensions:
- admonition
- pymdownx.details
- toc:
anchorlink: true
anchorlink_class: "toclink"
- pymdownx.snippets:
- pymdownx.magiclink:
- attr_list:
- md_in_html:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite:
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
- markdown.extensions.attr_list:
- pymdownx.keys:
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.tabbed:
alternate_style: true
plugins:
- search
- gh-admonitions
- llmstxt:
markdown_description: |
Ruff is an extremely fast Python linter and code formatter, written in Rust.
It can be used to replace Flake8 (plus dozens of plugins), Black, isort, pydocstyle,
pyupgrade, autoflake, and more, all while executing tens or hundreds of times faster
than any individual tool.
Ruff includes both a linter (`ruff check`) and a formatter (`ruff format`).
When fetching documentation, use explicit `index.md` paths for directories, e.g.,
`https://docs.astral.sh/ruff/editors/index.md`. This returns clean markdown instead
of rendered HTML with JS/CSS.
sections:
Getting started:
- installation.md
- tutorial.md
Configuration:
- configuration.md
Linter:
- linter.md
Formatter:
- formatter.md
- formatter/black.md
Editors:
- editors/index.md
- editors/setup.md
- editors/settings.md
- editors/features.md
- editors/migration.md
Integrations:
- integrations.md
Concepts:
- preview.md
- versioning.md
Reference:
- faq.md
extra_css:
- stylesheets/extra.css
extra_javascript:
- js/extra.js
not_in_nav: |
/rules/*
/formatter/*
extra:
analytics:
provider: fathom
social:
- icon: fontawesome/brands/github
link: https://github.com/astral-sh/ruff
- icon: fontawesome/brands/discord
link: https://discord.com/invite/astral-sh
- icon: fontawesome/brands/python
link: https://pypi.org/project/ruff/
- icon: fontawesome/brands/x-twitter
link: https://x.com/astral_sh
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn