ibc/mkdocs.yml at main · mighty-muffin/ibc · 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
---
site_name: IBC Documentation
site_description: Documentation for the Insecure Bank application
site_author: Mighty Muffin

docs_dir: docs

theme:
  name: material
  palette:
    scheme: slate
  features:
    - content.code.annotate
    - content.code.copy

markdown_extensions:
  - footnotes:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - Home: README.md
  - Project Overview: overview.md
  - Context: context.md
  - Architecture:
      - Overview: architecture/overview.md
      - Database: architecture/db.md
      - Middleware: architecture/middleware.md
  - Development:
      - Setup: development/setup.md
      - Running: development/running.md
      - Docker: development/docker.md
      - Dependencies: development/dependencies.md
      - Code Quality: development/quality.md
      - Contributing: development/contributing.md
  - Pipeline:
      - Overview: pipeline/overview.md
      - Branches: pipeline/branches.md
      - Dependabot: pipeline/dependabot.md
  - Security:
      - Overview: security/overview.md
      - Scenario 1: security/scenario-1.md
      - Scenario 2: security/scenario-2.md
      - Scenario 3: security/scenario-3.md
      - Scenario 4: security/scenario-4.md
      - Scenario 5: security/scenario-5.md
      - Scenario 6: security/scenario-6.md
  - Testing:
      - Overview: testing/overview.md