TutorialCreator/mkdocs.yml at main · AlexTabble/TutorialCreator · 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
site_name: Tutorial Creator

nav:
  - Home: index.md

  - Getting Started:
      - Installation: getting-started/installation.md
      - Usage: getting-started/using-the-program.md
      - Configuration: getting-started/configuration.md

  - Architecture:
      - Overview: architecture/overview.md
      - Object Relationships: architecture/object-relationships.md
      - Project Layout: architecture/project-layout.md

  - Creating Tutorials:
      - Overview: creating-tutorials/overview.md
      - Adding Config Paths: creating-tutorials/add-cfg-paths.md
      - Template Creation: creating-tutorials/create-templates.md
      - Program File: creating-tutorials/create-tutorial-logic.md
  - API:
      - Core:
          - Tutorial: api/core/tutorial.md
          - Question: api/core/question.md
          - Loader: api/core/loader.md
          - Seed: api/core/seed.md

      - Config:
          - Tutorial Config API: api/config/tutorialconfig-api.md

      - Renderer:
          - Injector: api/renderer/injector.md
          - Output Format: api/renderer/outputformat.md
          - Quarto: api/renderer/quarto.md


theme:
  name: material

  palette:
  - scheme: default
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode

  - scheme: slate
    toggle:
      icon: material/brightness-4
      name: Switch to light mode

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy