Starry-Tutorial-Book/mkdocs.yml at main · MTttth/Starry-Tutorial-Book · 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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
# Basics
site_name: Starry-Tutorial-Book
repo_url: https://github.com/Azure-stars/Starry-Tutorial-Book
repo_name: Starry-Tutorial-Book

theme:
  name: material
  language: zh
  custom_dir: theme/
  features:
    - navigation.top
    - navigation.tabs
    - navigation.indexes
  palette:
  - scheme: default
    primary: indigo
    accent: indigo
    toggle:
      icon: material/weather-night
      name: 切换为深色模式
  - scheme: slate
    primary: indigo
    accent: indigo
    toggle:
      icon: material/weather-sunny
      name: 切换为浅色模式

extra_javascript:
  - 'https://cdn.jsdelivr.net/npm/mathjax@2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'

plugins:
  - search
  - git-revision-date-localized:
      fallback_to_build_date: true
      locale: zh
  - git-authors:
      show_contribution: true
      show_line_count: true

markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
      linenums: true
  - footnotes
  - def_list
  - toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  # - pymdownx.emoji:
  #     emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

  - meta
  - pymdownx.highlight:
      linenums: true
  - pymdownx.keys
  - pymdownx.snippets
  - pymdownx.progressbar
  - pymdownx.superfences:
      custom_fences:
        - name: math
          class: arithmatex
          format: !!python/name:pymdownx.arithmatex.fence_mathjax_format
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format


# Contents
nav:
  - 欢迎来到 Starry-Tutorial-Book:
    - index.md
    - Starry 支持情况: ./intro/support.md

  - 快速上手:
    - setup/index.md
    - 环境配置: setup/env.md
    - 一个案例快速上手 Starry: setup/case_study.md
    - 运行基本应用: setup/basic.md
    - 运行 OS 比赛测例: setup/oscomp.md
    - Starry 的自定义配置: setup/customization.md
    - 更多复杂应用: setup/applications.md

  - 架构设计:
    - implementation/index.md
    - 整体架构: implementation/architecture.md
    - 启动与初始化: implementation/boot.md
    - implementation/monolithic.md

  - 模块细节:
    - modules/index.md
    - modules/core.md
    - modules/syscall.md
    - UserPtr 封装: modules/userptr.md
    - 宏内核进程管理: modules/process.md

  - ArceOS 模块细节:
    - arceos-modules/index.md
    - 运行时模块:
      - arceos-modules/runtime/index.md
    - 配置与构建系统模块:
      - arceos-modules/config/index.md
    - 硬件抽象层模块:
      - arceos-modules/hal/index.md
      - 模块接口与用例: arceos-modules/network/api.md
      - 自定义平台细节实现: arceos-modules/hal/customization.md
    - 动态内存分配模块:
      - arceos-modules/alloc/index.md
      - 模块接口与用例: arceos-modules/alloc/api.md
    - 驱动模块:
      - arceos-modules/driver/index.md
      - 驱动支持: arceos-modules/driver/support.md
      - 驱动总线支持: arceos-modules/driver/bus.md
    - 任务调度模块:
      - arceos-modules/task/index.md
      - 模块接口与用例: arceos-modules/task/api.md
      - 调度机制实现: arceos-modules/task/schedule.md
      - 多核调度支持: arceos-modules/task/multicore.md
    - 网络模块:
      - arceos-modules/network/index.md
      - 模块接口与用例: arceos-modules/network/api.md
      - 网络栈支持: arceos-modules/network/support.md
    - 文件系统模块:
      - arceos-modules/fs/index.md
      - 模块接口与用例: arceos-modules/fs/api.md
      - 文件系统兼容层: arceos-modules/fs/vfs.md
    - 虚拟内存管理模块:
      - arceos-modules/memory/index.md
      - 模块接口与用例: arceos-modules/memory/api.md
      - 内存管理机制: arceos-modules/memory/management.md
    - 命名空间模块:
      - arceos-modules/ns/index.md
      - arceos-modules/ns/management.md
      - arceos-modules/ns/api.md

  - 开发规划:
    - roadmap/index.md

  - 真实硬件平台开发:
    - hardware/index.md
    - x86 PC支持: hardware/x86-pc.md
    - 星光二代支持: hardware/sifive.md
    - 飞腾派支持: hardware/phytium.md
    - 树莓派支持: hardware/raspberry.md

  - 附录:
    - appendix/index.md
    - qemu-user 运行调试: appendix/qemu-user.md

  - 关于文档:
    - notes/index.md
    - 读者须知: notes/reader.md
    - 编辑者须知: notes/editor.md