docs/mkdocs.yml at main · ards-project/docs · 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
# Project information
site_name: AgenticResourceDiscovery.org
site_url: https://agenticresourcediscovery.org/
site_description: A protocol for discovering agentic resources — tools, Skills, MCP servers, APIs, workflows, and agents — for AI clients

# Configuration
theme:
  name: material
  custom_dir: overrides
  font:
    text: Outfit
    code: Fira Code
  palette:
    scheme: default
    primary: white
    accent: indigo
  features:
    - content.code.copy
    - content.code.select
    - content.tooltips
    - navigation.indexes
    # navigation.instant disabled: incompatible with StatiCrypt per-page
    # encryption (instant-loading fetches the encrypted template fragment
    # and injects it broken). Re-enable when password protection is removed.
    # - navigation.instant
    # - navigation.instant.progress
    - navigation.path
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - toc.follow

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      dedent_subsections: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

# Hide the "Made with Material for MkDocs" footer attribution
extra:
  generator: false

# Custom CSS
extra_css:
  - stylesheets/custom.css
  - stylesheets/homepage.css
  - stylesheets/nav.css

# Build hooks
# spec_from_canonical renders the spec page from the canonical ard-spec repo at
# build time (single source of truth; no manual sync). Falls back to the
# committed docs/spec.md if the repo isn't reachable.
hooks:
  - hooks/spec_from_canonical.py

# Plugins
# Empty list (not omitted) so MkDocs does NOT re-enable its default `search`
# plugin — this removes the header search box.
plugins:
  # `comparisons` was renamed to `interoperability`; keep the old URL working.
  - redirects:
      redirect_maps:
        comparisons.md: interoperability.md
        how_agents_search.md: how_to_build_a_client.md
        # 'Why ARD?' (Overview & Architecture) folded into 'How ARD works'.
        why.md: how_ard_works.md
        # 'Connect Copilot' was split into separate GitHub / Microsoft pages.
        connect/copilot.md: connect/github-copilot.md

# Navigation
nav:
  - Home: index.md
  - Get started: get_started.md
  - About:
    - Introduction: introduction.md
    - How ARD works: how_ard_works.md
    - Interoperability: interoperability.md
    - Contributors: contributors.md
    - FAQ: faq.md
    - Glossary: glossary.md
  - Guides:
    - Connect a chatbot:
      - Overview: connect.md
      - Claude: connect/claude.md
      - ChatGPT: connect/chatgpt.md
      - GitHub Copilot: connect/github-copilot.md
      - Microsoft Copilot: connect/microsoft-copilot.md
      - Gemini: connect/gemini.md
    - How to publish: how_to_publish.md
    - How to add ARD support to your agent: how_to_build_a_client.md
    - Reference Implementations: ref_implementations.md
  - Specifications:
    - ARD Specification: spec.md
    - AI Catalog Standard: ai_catalog_spec.md
  - Give feedback: '/faq/#how-can-i-give-feedback'

# Copyright
copyright: Apache License, Version 2.0.