yarlpattern/properdocs.yml at main · chad-loder/yarlpattern · GitHub

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
site_name: yarlpattern
site_description: WHATWG URLPattern for Python — 100% specification strict, pure Python, optimized and yarl-compatible
site_url: https://chad-loder.github.io/yarlpattern
repo_url: https://github.com/chad-loder/yarlpattern
repo_name: chad-loder/yarlpattern
edit_uri: edit/main/docs/

validation:
  anchors: warn

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.tabs.link
    - content.action.edit
    - navigation.footer
    - navigation.sections
    - navigation.expand
    - navigation.indexes       # section names link to <section>/index.md landing pages
    - navigation.tabs          # top-level sections render as sticky tabs in the header
    - navigation.tabs.sticky   # tabs stay pinned on scroll
    - navigation.path          # breadcrumbs above every page heading
    - navigation.tracking      # URL hash follows the active heading on scroll
    - toc.follow

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  # ``--8<-- "FILE"`` includes the file's content inline at build time;
  # ``base_path: ["."]`` lets us pull from the repo root so the About
  # section's pages can re-render CONTRIBUTING.md / CHANGELOG.md / etc.
  # without duplicating content.
  - pymdownx.snippets:
      base_path: ["."]
      check_paths: true
  - toc:
      permalink: true
  - attr_list
  - md_in_html

plugins:
  - search
  - code-validator:
      identifiers:
        python:
          validators:
            - "python -c \"import ast,sys; ast.parse(sys.stdin.read())\""
        bash:
          validators:
            - bash -n
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: false
            show_root_heading: true
            show_symbol_type_heading: true
            members_order: source
            docstring_style: google
            merge_init_into_class: true
            show_signature_annotations: true

nav:
  - Home: index.md
  - Overview:
      - overview/index.md
      - What is URLPattern?: overview/what-is-urlpattern.md
      - Ecosystem adoption: overview/ecosystem-adoption.md
  - Examples:
      - examples/index.md
      - Route a multi-tenant API by subdomain: examples/route-a-multi-tenant-api-by-subdomain.md
      - Add subdomain routing to aiohttp: examples/add-subdomain-routing-to-aiohttp.md
      - Add subdomain routing to FastAPI: examples/add-subdomain-routing-to-fastapi.md
      - Validate inbound webhooks by URL shape: examples/validate-inbound-webhooks-by-url-shape.md
      - Avoid regex hostname-allowlist credential leaks: examples/avoid-regex-hostname-allowlist-vulns.md
      - Match the KServe /v2/models inference path: examples/match-the-kserve-v2-inference-path.md
      - Pick an LLM backend by model name: examples/pick-an-llm-backend-by-model-name.md
      - Replace MCP resource URI templates: examples/replace-mcp-resource-uri-templates.md
      - Translate google.api.http to URLPattern: examples/translate-google-api-http-to-urlpattern.md
      - Classify GitHub URLs in markdown: examples/classify-github-urls-in-markdown.md
      - Extract YouTube video IDs from any URL form: examples/extract-youtube-video-ids-from-any-url-form.md
      - Match Slack callback IDs with structured data: examples/match-slack-callback-ids-with-structured-data.md
  - Reference:
      - reference/index.md
      - API: reference/api.md
  - Comparisons:
      - comparisons/index.md
      - vs. aiohttp.web.UrlDispatcher: comparisons/aiohttp.md
      - vs. yarl: comparisons/yarl.md
  - Explanation:
      - explanation/index.md
      - Architecture: explanation/architecture.md
  - WPT Conformance: wpt-compliance.md
  - About:
      - about/index.md
      - Contributing: about/contributing.md
      - Changelog: about/changelog.md
      - Security policy: about/security.md
      - Code of Conduct: about/code-of-conduct.md