# 如何在本站添加自己的文章

## 一、前提条件

需要会基本的git操作

## 二、总流程

### 1. 将本站fork到自己的仓库中

本站github链接：https://github.com/supperthomas/bluetoothlover_doc

![image-20250117175351132](https://picture-note-1328988318.cos.ap-nanjing.myqcloud.com/Typora/202501171753290.png)

fork到自己仓库中，例如：

![image-20250117181052531](https://picture-note-1328988318.cos.ap-nanjing.myqcloud.com/Typora/202501171810669.png)

### 2. 将自己仓库clone到本地，进行添加修改

![image-20250117180543609](https://picture-note-1328988318.cos.ap-nanjing.myqcloud.com/Typora/202501171805697.png)

具体文件中需要添加修改哪些内容，稍后再详细讲解

### 3. 从自己本地仓库进行pr

pr：全称Pull Request(请求拉取)，向工程仓库管理者提交请求，拉取自己的仓库到工程仓库中进行合并，达到合作目的

![image-20250117181007469](https://picture-note-1328988318.cos.ap-nanjing.myqcloud.com/Typora/202501171810574.png)

> pr不会？

满老师视频手把手教学：https://www.bilibili.com/video/BV1gr4y1w7yX/?spm_id_from=333.999.0.0&vd_source=cb3035aabee93b98268db84a2ab962fc

rtthread文档中心：https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/development-guide/github/github

## 三、本站本地结构详解

我们在电脑本地clone好了仓库，文章都存在source文件夹中，从00_supperthomas到18_Li-Dongze都是以目前的成员命名的文件夹，存放个人的学习笔记等个人博客。其他未以序号命名的文件是一些公有文件，如蓝牙协议栈介绍、工具推荐、开发板介绍等。

![image-20250117183730262](https://picture-note-1328988318.cos.ap-nanjing.myqcloud.com/Typora/202501171837371.png)

我们添加文章主要修改三个文件：source文件夹下的总index.rst文件、添加的子文件夹下的index.rst文件、我们的文章。

![image-20250117184931055](https://picture-note-1328988318.cos.ap-nanjing.myqcloud.com/Typora/202501171849151.png)

![image-20250117185044333](https://picture-note-1328988318.cos.ap-nanjing.myqcloud.com/Typora/202501171850426.png)

![image-20250117185155915](https://picture-note-1328988318.cos.ap-nanjing.myqcloud.com/Typora/202501171851000.png)

### 1. 修改总index文件

打开总index文件，它管理着各个子文件下的index文件，决定网站上显示的格式：最大标题深度、文章顺序...它的和我们添加的文件夹名一一对应（不可有中文），例如现在新加入了一个成员张三，我们可以创建一个叫“19_张三”的文件夹，并在后面加上一行：`19_张三/index`

> 注意：要和文件夹名一一对应

![image-20250117185301455](https://picture-note-1328988318.cos.ap-nanjing.myqcloud.com/Typora/202501171853521.png)

### 2. 添加子文件夹下index文件

接着修改子文件夹下index文件，如18_Li-Dongze文件夹

![image-20250117190948632](https://picture-note-1328988318.cos.ap-nanjing.myqcloud.com/Typora/202501171909676.png)

![image-20250117191156524](https://picture-note-1328988318.cos.ap-nanjing.myqcloud.com/Typora/202501171911636.png)

### 3. 添加自己的文章

用markdown格式写

> markdown不会？

参考本站WIKI FAQ 篇：https://supperthomas-wiki.readthedocs.io/WIKI_FAQ/index.html

## 四、总结

主要修改三个文件：source文件夹下的总index.rst文件、添加的子文件夹下的index.rst文件、我们的文章。