brkraw/mkdocs.yml at main · BrkRaw/brkraw · 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
site_name: A Modular Toolkit for Bruker MRI raw-data handling.
site_description: A modular toolkit for Bruker MRI raw-data handling.
site_url: https://brkraw.github.io/
repo_url: https://github.com/BrkRaw/brkraw
repo_name: BrkRaw/brkraw
edit_uri: edit/main/docs/
use_directory_urls: false

theme:
  name: material
  language: en
  custom_dir: docs/overrides
  favicon: assets/favicon.ico
  logo: assets/brkraw-logo.svg
  font:
    false
  palette:
    - scheme: default
      primary: custom
      accent: custom
  features:
    - navigation.tabs
    - navigation.top
    - navigation.sections
    - navigation.instant
    - navigation.instant.prefetch
    - search.highlight
    - search.share

markdown_extensions:
  - admonition
  - attr_list
  - toc:
      permalink: true
  - pymdownx.superfences
  - md_in_html

extra_css:
  - stylesheets/extra.css

nav:
  - Home: index.md

  - Getting Started:
      - Overview: getting-started/index.md
      - Command Line Interface: getting-started/cli.md
      - Python API: getting-started/api.md
      - Graphical User Interface: getting-started/gui.md
      - BIDS integration: getting-started/bids.md
      - User Configuration: getting-started/config.md

  - CLI Reference:
      - overview: cli/index.md
      - init: cli/init.md
      - session: cli/session.md
      - info: cli/info.md
      - params: cli/params.md
      - convert: cli/convert.md
      - prune: cli/prune.md
      - cache: cli/cache.md
      - config: cli/config.md
      - addon: cli/addon.md
      - hook: cli/hook.md

  - API Reference:
      - overview: api/overview.md
      - data access: api/data-access.md
      - info and params: api/info.md
      - convert: api/convert.md
      - prune: api/prune.md
      - layout: api/layout.md
      - addon: api/addon.md
      - hook: api/hook.md

  - Extensions:
      - Overview: extensions/extensibility.md
      - Addons and plugins: extensions/addons-and-plugins.md
      - CLI plugins (overview): extensions/cli-extensions.md
      - Rules: extensions/rules.md
      - Specs: extensions/specs.md
      - Context maps: extensions/context-map.md
      - Layout and naming: extensions/layout.md
      - Hook packages (overview): extensions/hook-packages.md

  - Developer Guide:
      - Contributing: dev/contributing.md
      - Core vs addon development: dev/core-vs-addon.md
      - Building CLI plugins: dev/cli-extensions.md
      - Building hook packages: dev/hook-packages.md
      - Roadmap: dev/roadmap.md
      - Documentation: dev/documentation.md
      - Contributors: dev/contributors.md