SpaceBlocks/mkdocs.yml at main · cbib/SpaceBlocks · 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
site_name: SpaceBlocks
site_description: A Snakemake workflow for single-cell-resolution spatial transcriptomics
repo_url: https://github.com/cbib/SpaceBlocks
repo_name: cbib/SpaceBlocks
edit_uri: edit/main/docs/

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  palette:
    - scheme: default
      primary: teal
      accent: teal
      toggle: { icon: material/weather-night, name: Switch to dark mode }
    - scheme: slate
      primary: teal
      accent: teal
      toggle: { icon: material/weather-sunny, name: Switch to light mode }
  features:
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.code.copy
    - toc.follow

markdown_extensions:
  - admonition
  - attr_list
  - tables
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.snippets:            # lets docs pages include repo-root files (single source)
      base_path: ["."]
      check_paths: true
  - toc:
      permalink: true
      # GitHub-compatible heading slugs, so TOC anchors written for GitHub (e.g. the
      # em-dash "Coreblock 1 — preprocessing") resolve identically on the rendered site.
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower

plugins:
  - search

nav:
  - Home: index.md
  - Configuration: configuration.md
  - Get started: getting-started.md
  - Demos: demos.md
  - QuPath annotation: qupath-tutorial.md
  - Design & architecture: design.md
  - Outputs: outputs.md
  - Rule reference: rules.md
  - Environments: environments.md