bactscout/mkdocs.yml at main · ghruproject/bactscout · 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
site_name: BactScout
site_description: High-performance bacterial genome quality control and MLST analysis pipeline
site_url: https://github.com/ghruproject/bactscout
repo_url: https://github.com/ghruproject/bactscout
repo_name: ghruproject/bactscout
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
      primary: teal
      accent: lime
    - scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode
      primary: teal
      accent: lime
  features:
    - navigation.tabs
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.view
    - content.action.edit

plugins:
  - search

markdown_extensions:
  - pymdownx.emoji
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      use_pygments: true
  - md_in_html
  - admonition
  - pymdownx.details
  - tables
  - footnotes
  - attr_list

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quick-start.md
      - Configuration: getting-started/configuration.md
      - MLST Databases: getting-started/mlst-species.md
  - Usage:
      - QC Command: usage/qc-command.md
      - Collect Command: usage/collect-command.md
      - Summary Command: usage/summary-command.md
      - Output Format: usage/output-format.md
  - Guide:
      - Quality Control Criteria: guide/quality-control.md
      - Scaling up: guide/scaling.md
      - Troubleshooting: guide/troubleshooting.md
  - Reference:
      - API Reference: reference/api.md
      - Configuration Reference: reference/configuration.md
      - FAQ: reference/faq.md
      - Contributing: contributing.md