TakoVM/mkdocs.yml at main · Aydeing/TakoVM · 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
site_name: Tako VM
site_description: Secure Python code execution and job queue infrastructure for AI agents — run untrusted code in gVisor-isolated Docker containers with workers, retries, and replay.
site_url: https://las7.github.io/TakoVM/
site_author: Tako VM

repo_url: https://github.com/las7/TakoVM
repo_name: TakoVM
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.instant
    - navigation.tracking
    - navigation.path
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.select
    - content.action.edit
    - content.tabs.link
    - toc.integrate

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Configuration: getting-started/configuration.md
  - Architecture: architecture.md
  - API Reference:
    - REST API: api/rest.md
    - Python SDK: api/sdk.md
  - Guide:
    - Tutorial: guide/tutorial.md
    - Basic Execution: guide/basic-execution.md
    - Async Jobs: guide/async-jobs.md
    - Environments: guide/environments.md
    - Custom Libraries: guide/custom-libraries.md
    - Error Handling: guide/error-handling.md
  - Deployment:
    - How to Deploy: deployment/how-to-deploy.md
    - Production Setup: deployment/production.md
    - Scaling: deployment/scaling.md
    - Operations: deployment/operations.md
    - Security: deployment/security.md
  - Security:
    - Mitigations: security/mitigations.md
    - Vulnerability Analysis: security/proc-exposure-vulnerability.md
  - Comparison: comparison.md

plugins:
  - search
  - social:
      # Set CARDS=false to skip social-card image generation locally
      # (avoids needing the Cairo/Pango imaging libraries during `mkdocs serve`).
      cards: !ENV [CARDS, true]
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago

markdown_extensions:
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.mark
  - admonition
  - tables
  - attr_list
  - md_in_html
  - footnotes
  - def_list

extra:
  # Uncomment and set your Google Analytics 4 property ID to enable analytics.
  # analytics:
  #   provider: google
  #   property: G-XXXXXXXXXX
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/las7/TakoVM