QuantLab/mkdocs.yml at main · sefaav/QuantLab · 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
site_name: QuantLab
site_description: Reproducible quantitative research and backtesting platform
site_url: https://sefaav.github.io/QuantLab/
repo_url: https://github.com/sefaav/QuantLab
docs_dir: docs

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

nav:
  - Home: index.md
  - Architecture: architecture.md
  - Data pipeline: data_pipeline.md
  - Strategies: strategies.md
  - Strategy Explorer: strategy_explorer.md
  - Python API: api.md
  - Backtesting: backtesting.md
  - Drift compliance: drift_compliance.md
  - Validation: validation.md
  - Limitations: limitations.md

markdown_extensions:
  - admonition
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight
  - tables
  - toc:
      permalink: true