提交代码和更新文档¶

提交代码¶

提交代码请参考rt-thread文档

项目文档使用MkDocs（主题采用Material for MkDocs）构建，使用Github Pages来作为展示的站点。

Tip

MkDocs(Markdown Documents)是一个快速、简单和华丽的静态网站生成器，用于将Markdown文档组织起来构建成有层次、美观的文档站点。

GitHub Pages是一项静态站点托管服务，它直接从GitHub上的仓库获取HTML,CSS和JavaScript文件，通过构建过程运行文件，然后发布网站。

文档框架已经搭建好，只需要简单几步就可以完成文档的集成。

MkDocs文档需要采用Markdown语法进行编写，常用的Markdown语法比较简单，可以参考Markdown官方教程，也可以参考本项目中已使用的语法。

如果在已有章节上添加内容，直接添加即可。

如果需要新建章节，请在项目docs文件夹（或子文件夹）内新建.md文件，如docs/basic/提交代码和更新文档.md。

打开项目中的mkdocs.yml文件，将新编写的Markdown文件加入目录树中。

# Page tree
nav:
  - 前言: 'index.md'
  - 提交代码和更新文档: 'basic/提交代码和更新文档.md'

冒号前为生成文档中的目录名，冒号后为Markdown文件在docs文件夹内的路径。

提交代码后就会自动通过Github Actions生成文档，稍等几分钟就可以在SYNWIT芯片自动化测试看到生成的文档了。🎉🎉🎉