Cirro-app-kit/mkdocs.yml at main · CirroBio/Cirro-app-kit · 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
site_name: Cirro App Kit
site_description: Building browser apps on the Cirro platform
site_url: https://cirrobio.github.io/Cirro-app-kit/
repo_url: https://github.com/CirroBio/Cirro-app-kit
repo_name: CirroBio/Cirro-app-kit
edit_uri: edit/main/

# The site mirrors the repo layout so the Markdown's relative links work both
# on GitHub and here: site-hooks/pages.py replaces the docs_dir file list with
# the repo paths in SITE_PATHS, points links to code (templates, tools) at
# GitHub, and handles the README's repo-only and site-only blocks.
docs_dir: docs
watch:
  - README.md
  - CONTRIBUTING.md
  - reference
  - templates/app/README.md
hooks:
  - site-hooks/pages.py

theme:
  name: material
  logo: assets/cirro-logo.png
  favicon: assets/favicon.ico
  features:
    - navigation.sections
    - navigation.footer
    - navigation.top
    - content.code.copy
    - search.highlight
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra_css:
  - assets/cirro.css

markdown_extensions:
  - admonition
  - attr_list
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true

validation:
  nav:
    omitted_files: warn
  links:
    anchors: warn

nav:
  - Home: README.md
  - Start here:
      - Cirro in five minutes: docs/concepts.md
      - Getting started: docs/getting-started.md
      - App template: templates/app/README.md
      - Building on Cirro: docs/building-on-cirro.md
  - Registration and access:
      - App types and registration: docs/app-types-and-registration.md
      - Permissions: docs/permissions.md
      - Authentication: docs/authentication.md
  - Building:
      - Architecture: docs/architecture.md
      - Cirro TypeScript packages: docs/packages.md
      - Calling the API: docs/calling-the-api.md
      - Working with files: docs/files.md
      - Sheets: docs/sheets.md
      - Workspaces: docs/workspaces.md
  - Shipping:
      - Deployment: docs/deployment.md
      - Connecting to tenants: docs/connecting-to-tenants.md
      - Security checklist: docs/security-checklist.md
      - Troubleshooting: docs/troubleshooting.md
  - Reference:
      - API surface: reference/api-surface.md
      - Response models: reference/models.md
  - Contributing: CONTRIBUTING.md