openblox/mkdocs.yml at main · blox-eng/openblox · 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
site_name: openblox
site_description: Secure sandboxes for running untrusted, AI-generated code. A small Go library over Docker and gVisor.
site_url: https://openblox.sh
repo_url: https://github.com/blox-eng/openblox
repo_name: blox-eng/openblox
edit_uri: edit/main/docs/
copyright: MIT licensed

theme:
  name: material
  # The header is black in both palettes, so the light-ink mark is the one that
  # belongs there. The favicon is the dark-ink variant, for light browser tabs.
  logo: assets/openblox-mark-dark.svg
  favicon: assets/openblox-mark.svg
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - content.code.copy
    - content.action.edit
    - search.suggest
    - search.highlight
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: black
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: white
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Quick start: getting-started.md
  - Security model: security.md
  - The image contract: image.md
  - Contributing: contributing.md

plugins:
  - search
  # A large share of readers are agents, and this project's subject matter is
  # running the code they write. Emit a form they can consume directly.
  - llmstxt:
      full_output: llms-full.txt
      sections:
        Overview:
          - index.md
        Usage:
          - getting-started.md
          - image.md
        Security:
          - security.md

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/blox-eng/openblox