g-nom-project.github.io/mkdocs.yml at main · G-nom-Project/g-nom-project.github.io · 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
site_name: G-nom Docs
site_url: https://g-nom-project.github.io
repo_url: https://github.com/G-nom-Project/g-nom
repo_name: G-nom-Project/g-nom
theme:
  logo: assets/gnom.png
  favicon: assets/gnom.png
  icon:
    repo: fontawesome/brands/github
  name: material
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference

nav:
  - Welcome to the G-nom docs: index.md
  - User Guide:
    - Overview: user-guide/guide.md
    - Signing up: signup.md
    - User roles and groups: user-guide/groups.md
    - User dashboard: user-guide/dashboard.md
    - Data hierarchy: user-guide/data-hierarchy.md
    - Assembly Page: user-guide/assembly-page.md
    - Genome Browser: user-guide/browser.md
    - Importing data: user-guide/import.md
  - Admin Guide:
    - Installation: setup.md
    - Database: admin-guide/database.md
    - Workers: admin-guide/workers.md
    - Reverb: admin-guide/reverb.md
    - Plugins: plugins.md
  - Pipelines: pipelines.md

markdown_extensions:
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - md_in_html
  - pymdownx.blocks.caption
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - toc:
      permalink: true