frame/mkdocs.yml at main · pitabwire/frame · 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
site_name: Frame
site_description: "A Go framework for building vendor-agnostic cloud-native services with HTTP, gRPC, and Connect RPC"
site_url: "https://pitabwire.github.io/frame/"
repo_name: pitabwire/frame
repo_url: "https://github.com/pitabwire/frame"
edit_uri: "edit/main/docs/"
exclude_docs: |
  venv/

theme:
  name: material
  logo: assets/logo-white.svg
  favicon: assets/logo.svg
  icon:
    repo: fontawesome/brands/git-alt
  features:
    - search.highlight
    - navigation.tabs
    - navigation.top
    - navigation.expand
    - content.tabs.link
    - content.code.copy
  palette:
    - scheme: default
      primary: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: "IBM Plex Sans"
    code: "IBM Plex Mono"

markdown_extensions:
  - admonition
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - tables

plugins:
  - search

extra_css:
  - assets/styles.css

nav:
  - Overview:
      - Home: index.md
      - Architecture: architecture.md
      - Getting Started: getting-started.md
      - Monorepo: monorepo.md
      - Service Lifecycle: service.md
      - Plugins & Options: plugins-options.md
      - AI Assistants: ai-assistants.md
      - Blueprints: blueprints.md
      - Examples: examples.md
  - Runtime:
      - Server: server.md
      - Configuration: configuration.md
      - OpenAPI: openapi.md
      - Logging: logging.md
      - Telemetry: telemetry.md
      - Profiler: profiler.md
      - TLS: tls.md
  - Data & Infra:
      - Datastore: datastore.md
      - Cache: cache.md
      - Queue: queue.md
      - Events: events.md
      - Worker Pool: workerpool.md
      - Rate Limiter: ratelimiter.md
      - HTTP Client: client.md
  - Security:
      - Authentication: security-authentication.md
      - Authorization: security-authorization.md
      - Interceptors: security-interceptors.md
  - Localization & Utilities:
      - Localization: localization.md
      - Data Utilities: data-utilities.md
      - Testing: testing.md