SpliceCraft/mkdocs.yml at master · Binomica-Labs/SpliceCraft · 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
site_name: SpliceCraft
site_description: Terminal-based plasmid map viewer, sequence editor, and cloning/mutagenesis workbench in pure Python.
site_url: https://binomica-labs.github.io/SpliceCraft/
repo_url: https://github.com/Binomica-Labs/SpliceCraft
repo_name: Binomica-Labs/SpliceCraft
edit_uri: edit/master/docs/

# Material theme is the most-deployed mkdocs theme and ships every
# component a project this scope needs out of the box (navigation
# tree, search, copy-code button, tabbed code blocks). Pin to a
# major version so a breaking release doesn't break the doc build.
theme:
  name: material
  features:
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - content.code.copy
    - content.action.edit
    - search.suggest
    - search.highlight
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font: false   # don't pull in Google Fonts — privacy + offline

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

# Dev-internal references (sweep history + subsystem deep-dives) stay in
# the repo for contributors but are excluded from the public site —
# subsystems.md also contains raw regexes whose `<![` trips mkdocs's
# HTML pass, and invariants.md is a 190 KB agent-facing changelog.
exclude_docs: |
  invariants.md
  subsystems.md

nav:
  - Home: index.md
  - Install: install.md
  - Getting started: getting-started.md
  - Features:
    - Overview: features.md
    - Keybindings + menus: keybindings.md
  - Data safety + backups: data-safety.md
  - Agent + scripting:
    - Agent API: agent-api.md
    - CLI sidecar: cli.md
  - Architecture: architecture.md
  - Supported terminals: PLATFORMS.md
  - Project:
    - Contributing: https://github.com/Binomica-Labs/SpliceCraft/blob/master/CONTRIBUTING.md
    - Security policy: https://github.com/Binomica-Labs/SpliceCraft/blob/master/SECURITY.md
    - v1.0.0 acceptance gate: https://github.com/Binomica-Labs/SpliceCraft/blob/master/V1_GATE.md
    - Changelog: https://github.com/Binomica-Labs/SpliceCraft/blob/master/CHANGELOG.md