hotcell/mkdocs.yml at master · basecamp/hotcell · 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
---
site_name: "Hot Cell"
site_url: https://basecamp.github.io/hotcell/
site_description: "Run untrusted file conversions in a separate, isolated process."
repo_name: basecamp/hotcell
repo_url: https://github.com/basecamp/hotcell
edit_uri: ""
copyright: "Copyright © 37signals, LLC"

# `rake site:stage` fills this from README.md and docs/. See rakelib/site.rake.
docs_dir: tmp/site/staging
site_dir: tmp/site/build

theme:
  name: material
  logo: docs/radioactive.svg
  favicon: docs/hotcell-logo.png
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - search.highlight
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: lucide/sun-moon
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: lucide/sun
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: lucide/moon
        name: Switch to system preference
  icon:
    repo: fontawesome/brands/github

extra:
  generator: false

markdown_extensions:
  - admonition
  - tables
  - toc:
      permalink: true
      # The docs are written for GitHub and link to its heading anchors, which keep repeated hyphens.
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

nav:
  - Home: index.md
  - Reference manual:
      - docs/index.md
      - Concepts: docs/concepts.md
      - Request lifecycle: docs/request-lifecycle.md
      - Client API: docs/client-api.md
      - Operation API: docs/operation-api.md
      - Response codes: docs/codes.md
      - Container: docs/container.md
      - Scratch: docs/scratch.md
      - Cell settings: docs/cell-settings.md
      - Tuning: docs/tuning.md
      - Observability: docs/observability.md
      - Conformance: docs/conformance.md
      - Active Storage operations: docs/active-storage.md
      - ImageMagick: docs/imagemagick.md
  - Design:
      - docs/design/index.md
      - Threat model: docs/design/threat-model.md
      - Invariants: docs/design/invariants.md
      - Worker isolation: docs/design/worker-isolation.md
      - Passing file descriptors: docs/design/descriptors.md
  - Contributing:
      - docs/contributing/index.md
      - Working on the gems: docs/contributing/guide.md
      - Keep the docs current: docs/contributing/docs.md
      - Architecture decision records: docs/contributing/decisions.md
      - Established by experiment: docs/contributing/experiments.md
      - Cell overhead: docs/contributing/overhead.md