mlstdb/mkdocs.yml at main · MDU-PHL/mlstdb · 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
site_name: mlstdb
site_description: A Python package to update and manage the MLST database for the mlst tool
site_url: https://MDU-PHL.github.io/mlstdb
repo_url: https://github.com/MDU-PHL/mlstdb
repo_name: MDU-PHL/mlstdb

theme:
  name: material
  palette:
    - scheme: default
      primary: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - content.code.copy

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]

nav:
  - Home: index.md
  - Installation: installation.md
  - Getting Started: getting-started.md
  - Usage:
      - Overview: usage/overview.md
      - Connect: usage/connect.md
      - Update: usage/update.md
      - Purge: usage/purge.md
      - Fetch (Advanced): usage/fetch.md
  - Disclaimer: disclaimer.md
  - Changelog: changelog.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.tabbed:
      alternate_style: true