forked from RT-Thread/rtthread-manual-doc
-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
110 lines (96 loc) · 4.32 KB
/
mkdocs.yml
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
site_name: RT-Thread 文档中心
site_author: RT-Thread
theme: 'material'
docs_dir: rtthread-manual-doc
# Repository
repo_name: 'RT-Thread/rt-thread'
repo_url: 'https://github.com/RT-Thread/rt-thread'
extra_css: []
extra_javascript: []
extra_templates: []
# Options
extra:
feature:
tabs: true
markdown_extensions:
- codehilite
- admonition
- meta
pages:
- 主页: 'index.md'
- 教程:
- 入门教程:
- 'RT-Thread新手入门': 'docs/tutorials/quickstart.md'
- 'RT-Thread编程风格': 'docs/tutorials/codingstyle.md'
- '为RT-Thread贡献代码': 'zh/9appendix/03_github.md'
- 'RT-Thread配置选项参考': 'docs/tutorials/rtconfig.md'
- 'PDF手册下载': 'docs/tutorials/download.md'
# - 进阶教程:
# - 'RT-Thread进阶': 'docs/tutorials/advanced.md'
# - 高级教程:
# - 'RT-Thread高级': 'docs/tutorials/senior.md'
#- 入门指南:
# - 'RT-Thread/ESP32': 'zh/4chapters/quickstart_esp32.md'
# - '主页': 'zh/0preface/00-chapter1-preface.md'
# - '致谢': 'zh/0preface/00-chapter3-acknowledgement.md'
- 用户手册:
- RT-Thread编程手册:
- '前言': 'zh/0preface/00-chapter1-preface.md'
# - '简介': 'zh/1chapters/01-chapter_introduction.md'
- '线程调度与管理': 'zh/1chapters/02-chapter_thread.md'
- '定时器': 'zh/1chapters/03-chapter_timer.md'
- '任务间同步及通信': 'zh/1chapters/04-chapter_ipc.md'
- '内存管理 ': 'zh/1chapters/05-chapter_memory.md'
- 'I/O设备管理': 'zh/1chapters/06-chapter_device.md'
- '异常与中断': 'zh/1chapters/07-chapter_exception.md'
- '应用模块': 'zh/1chapters/08-chapter_application.md'
- 'finsh shell': 'zh/1chapters/11-chapter_finsh.md'
- '文件系统': 'zh/1chapters/12-chapter_filesystem.md'
- 'lwIP - 轻型TCP/IP协议栈': 'zh/1chapters/13-chapter_lwip.md'
- 'lwIP-IPv6 支持': 'zh/1chapters/14-chapter_ipv6.md'
- 'POSIX接口': 'zh/1chapters/15-chapter_posix.md'
# - 'RT-Thread API手册': 'zh/1chapters/07-chapter_exception.md'
# - 'RT-Thread组件手册':
# - '图像用户界面引擎': 'zh/1chapters/16-chapter_gui_engine.md'
# - 'RT-Thread设备和驱动手册': 'zh/1chapters/07-chapter_exception.md'
# - 'RT-Thread移植手册':
# - '移植': 'zh/1chapters/09-chapter_porting.md'
- 'RT-Thread工具手册':
- 'RT-Thread Env工具手册': 'zh/5chapters/01-chapter_env_manual.md'
- 'Scons构建系统': 'zh/1chapters/10-chapter_scons.md'
- 应用笔记:
# - 移植说明:
# - 'Risc-V架构芯片移植说明': 'docs/applicationnote/risc-v.md'
# - 'C-SKY架构芯片移植说明': 'docs/applicationnote/c-sky.md'
- 'AN0001：Serial设备应用笔记': 'docs/applicationnote/an0001_uart.md'
- 开发板说明:
- '正点原子板Nano入门环境搭建': 'docs/applicationnote/apollo_nano_start.md'
- 'AN0001': 'docs/applicationnote/an0001_uart.md'
# - '正点原子板IoT入门环境搭建': 'docs/applicationnote/apollo_advanced.md'
# - '[正点原子板]RT-Thread实验手册': 'docs/applicationnote/rtt_experiment.md'
# - '[QEMU模拟器]IoT进阶环境搭建': 'docs/applicationnote/qemu_iot_advanced.md'
# - 学习笔记:
# - '搭建Systemview调试环境': 'docs/applicationnote/systemview.md'
#- 示例:
# - 'RT-Thread内核示例': 'zh/1chapters/08-chapter_application.md'
# - 'RT-Thread组件示例': 'zh/1chapters/08-chapter_application.md'
# - 'RT-Thread设备和驱动示例': 'zh/1chapters/16-chapter_gui_engine.md'
- 发布说明:
- 'RT-Thread Nano发布说明': 'docs/releasenotes/nano_release.md'
# - 'RT-Thread IoT 3.0发布说明': 'docs/releasenotes/iot3_release.md'
#- 设备驱动:
# - '字符设备': 'zh/2chapters/01-char-device.md'
# - '块设备': 'zh/2chapters/02-block-device.md'
# - 'IIC设备': 'zh/2chapters/03-iic-device.md'
# - 'SPI设备': 'zh/2chapters/04-spi-device.md'
# - 'MMC/SD设备': 'zh/2chapters/05-mmc_sdio-device.md'
# - 'pin设备': 'zh/2chapters/06-pin-device.md'
# - 'EMAC以太网设备': 'zh/2chapters/07-emac-device.md'
# - 'Wi-Fi设备': 'zh/2chapters/08-wlan-device.md'
# - 'USB从机设备': 'zh/2chapters/09-usb-device.md'
# - 'USB主机设备': 'zh/2chapters/10-usb-host.md'
#- 移植开发:
# - '新架构移植': 'zh/3chapters/porting_arch.md'
# - 'ARM Cortex-M架构移植': 'zh/3chapters/porting_arch.md'
#- 常见问题:
# - '主页': 'zh/4chapters/README.md'