calkit/mkdocs.yml at main · Allen58562/calkit · 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
site_name: Calkit
repo_name: calkit/calkit
repo_url: https://github.com/calkit/calkit.git
theme:
  name: material
  logo: img/c-to-the-k-white.svg
  features:
    - content.code.copy
    - navigation.footer
    - navigation.indexes
    - navigation.top
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: teal
      accent: cyan
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: teal
      accent: cyan
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
nav:
  - Home: index.md
  - Installation: installation.md
  - Quickstart: quickstart.md
  - Sharing, collaboration, and backup (Calkit hub):
      - hub/index.md
      - Running your own: hub/self-hosting.md
  - Use with AI tools: ai-tools.md
  - Questions, hypotheses, answers, and evidence: questions.md
  - Version control: version-control.md
  - The calkit.yaml file: calkit-yaml.md
  - Dependencies, configuration, and secrets: dependencies.md
  - Environments: environments.md
  - The pipeline:
      - pipeline/index.md
      - pipeline/running-and-logging.md
      - pipeline/manual-steps.md
  - Notebooks: notebooks.md
  - JupyterLab: jupyterlab.md
  - High performance computing (HPC): hpc.md
  - Datasets: datasets.md
  - References: references.md
  - Calculations: calculations.md
  - Apps: apps.md
  - Releasing/archiving projects and artifacts: releases.md
  - Local server (GUI interaction): local-server.md
  - Overleaf integration: overleaf.md
  - Subprojects: subprojects.md
  - Examples: examples.md
  - Tutorials:
      - tutorials/index.md
      - tutorials/first-project.md
      - tutorials/jupyterlab.md
      - tutorials/existing-project.md
      - tutorials/openfoam.md
      - tutorials/adding-latex-pub-docker.md
      - tutorials/latex-codespaces.md
      - tutorials/notebook-pipeline.md
      - tutorials/procedures.md
      - tutorials/conda-envs.md
      - tutorials/office.md
      - tutorials/matlab.md
      - tutorials/github-actions.md
      - tutorials/vscode-slurm-notebook.md
      - tutorials/ai-agents.md
  - CLI reference: cli-reference.md
  - Help and support: help.md
  - Reproducibility: reproducibility.md
  - Governance: governance.md
  - Acknowledgements: acknowledgements.md
markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.blocks.caption
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      # Make exceptions to highlighting of code:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom ""
plugins:
  - search
  - mermaid2
  - glightbox

extra:
  analytics:
    provider: google
    property: G-B87E6N95DH