RRational/mkdocs.yml at main · saiko-psych/RRational · 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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
site_name: RRational
site_description: "A rational approach to Heart Rate Variability analysis"
site_url: https://rrational.readthedocs.io/
repo_url: https://github.com/saiko-psych/rrational
repo_name: saiko-psych/rrational
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/favicon.svg
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.path
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - search.suggest
    - search.highlight
    - search.share
    - toc.follow
    - header.autohide
  icon:
    repo: fontawesome/brands/github
    admonition:
      note: fontawesome/solid/note-sticky
      tip: fontawesome/solid/lightbulb
      warning: fontawesome/solid/triangle-exclamation
      danger: fontawesome/solid/skull-crossbones
      info: fontawesome/solid/circle-info
      example: fontawesome/solid/flask

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/saiko-psych/rrational
  version:
    provider: mike

extra_css:
  - assets/stylesheets/extra.css

plugins:
  - search

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.tilde
  - pymdownx.smartsymbols
  - admonition
  - pymdownx.details
  - toc:
      permalink: true
  - tables
  - def_list
  - attr_list
  - md_in_html
  - footnotes
  - abbr
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.snippets

nav:
  - Home: index.md
  - Getting Started:
    - When to Use RRational: getting-started/use-cases.md
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - FAQ: getting-started/faq.md
  - User Guide:
    - Complete Workflow: user-guide/workflow.md
    - Data Formats: user-guide/data-formats.md
    - Configuration & Projects: user-guide/configuration.md
  - Methodology:
    - Recommended Workflow: science/recommended-workflow.md
    - HRV Guidelines: science/guidelines.md
    - Processing Pipeline: science/processing-pipeline.md
  - Development:
    - Architecture: development/architecture.md
    - Contributing: development/contributing.md
    - Issue Handling: development/issue-handling.md
  - Reference:
    - Glossary: reference/glossary.md