pyproc/mkdocs.yml at main · YuminosukeSato/pyproc · 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
122
123
124
125
site_name: pyproc
site_url: https://yuminosukesato.github.io/pyproc
site_description: Run Python like a local function from Go — no CGO, no microservices
site_author: Yuminosuke Sato
repo_url: https://github.com/YuminosukeSato/pyproc
repo_name: YuminosukeSato/pyproc
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  palette:
    # Light mode
    - scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - scheme: slate
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.action.view

plugins:
  - search:
      separator: '[\s\-\.]+'
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true

markdown_extensions:
  # Code highlighting
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - pymdownx.snippets

  # Tabs and accordion
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details

  # Lists and tables
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - tables

  # Links and images
  - attr_list
  - md_in_html

  # Metadata
  - meta
  - toc:
      permalink: true
      toc_depth: 3

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/YuminosukeSato/pyproc
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pyproc-worker/

nav:
  - Home: index.md
  - Getting Started:
    - Overview: getting-started/index.md
    - Quick Start: getting-started/quick-start.md
    - Installation: getting-started/installation.md
    - Your First Integration: getting-started/first-integration.md
  - Guides:
    - Type-Safe API: guides/type-safe-api.md
    - Worker Development: guides/worker-development.md
    - Error Handling: guides/error-handling.md
    - Performance Tuning: guides/performance-tuning.md
    - Observability: observability.md
    - Testing: guides/testing.md
  - Deployment:
    - Docker: deployment/docker.md
    - Kubernetes: deployment/kubernetes.md
    - Cloud Authentication: deployment/cloud-authentication.md
    - Secrets Management: deployment/secrets-management.md
    - Monitoring: deployment/monitoring.md
    - Troubleshooting: deployment/troubleshooting.md
  - Reference:
    - Architecture: reference/architecture.md
    - Security: reference/security.md
    - Operations: reference/operations.md
    - Codec Performance: reference/codec-performance.md
    - API Reference: https://pkg.go.dev/github.com/YuminosukeSato/pyproc
  - Community:
    - Contributing: community/contributing.md
    - Changelog: community/changelog.md
    - FAQ: community/faq.md