ruff/mkdocs.template.yml
Charlie Marsh d7ffe46054
Disable the typeset plugin (#13517)
## Summary

There seems to be a bad interaction between enabling anchorlinks and the
`typeset` plugin. I think the former is more important than the
latter... so disabling the latter for now.

## Test Plan

Before:

![Screenshot 2024-09-25 at 7 53
21 PM](https://github.com/user-attachments/assets/bf7c70bb-19ab-4ece-9709-4c297f8ba67b)

After:

![Screenshot 2024-09-25 at 7 53
12 PM](https://github.com/user-attachments/assets/e767a575-1664-4288-aecb-82e8b1b1a7bd)
2024-09-25 23:58:35 +00:00

79 lines
2 KiB
YAML

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:
- markdown.extensions.attr_list:
- pymdownx.keys:
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.tabbed:
alternate_style: true
plugins:
- search
extra_css:
- stylesheets/extra.css
extra_javascript:
- js/extra.js
not_in_nav: |
/rules/*
/formatter/*
extra:
analytics:
provider: fathom
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn