noobkernel-doc/mkdocs.yml at main · NoobOSLab/noobkernel-doc · 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
site_name: NoobKernel Documentation
site_description: A simple educational operating system kernel
site_author: NoobOSLab

repo_url: https://github.com/NoobOSLab/noobkernel-doc
repo_name: NoobOSLab/noobkernel-doc

theme:
  name: material
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    - scheme: default
      primary: white
      accent: blue
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.top
    - search.suggest
  icon:
    repo: fontawesome/brands/github

nav:
  - Home: index.md
  - Getting Started:
    - Environment Setup: getting-started/environment-setup.md
    - Building: getting-started/building.md
    - Debugging: getting-started/debugging.md
  - Architecture:
    - Overview: architecture/overview.md
    - Boot Process: architecture/boot-process.md
    - Memory Layout: architecture/memory-layout.md
  - Modules:
    - Boot: modules/boot.md
    - HAL: modules/hal.md
    - Memory Management: modules/mm.md
    - Task Management: modules/task.md
    - Synchronization: modules/sync.md
    - File System: modules/fs.md
    - Trap: modules/trap.md
    - Misc: modules/misc.md
  - API Reference:
    - Memory API: api/memory-api.md
    - Process API: api/process-api.md
    - Filesystem API: api/filesystem-api.md
    - Synchronization API: api/synchronization-api.md
  - Development:
    - Roadmap: development/roadmap.md
    - Coding Style: development/coding-style.md

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search

extra_css:
  - stylesheets/extra.css