update contribute_doc_zh
wonderfullook
@@ -1,47 +1,21 @@
|
||||
# 分享文档
|
||||
|
||||
## 准备环境
|
||||
如果你有什么好的文档想分享出来的话，可以上传到 wiki 上
|
||||
|
||||
- wiki 网站是使用 teedoc 构建的。因此需要先准备环境
|
||||
下面是操作步骤：
|
||||
|
||||
### teedoc 说明
|
||||
---
|
||||
|
||||
关于网站框架，使用时有疑问的话可以参考 https://teedoc.github.io/
|
||||
目前 wiki 主要网页支持 markdown 和 ipynb 两种说明文档
|
||||
|
||||
### 本地构建网站
|
||||
我们在 https://github.com/sipeed/sipeed_wiki/tree/main/docs 页面选择 'Upload files'
|
||||
|
||||
- 安装teedoc
|
||||
|
||||
|
||||
```python
|
||||
pip3 install teedoc --upgrade
|
||||
```
|
||||
在接下来的页面中我们**把想要分享的文档直接拖拽到红框处，比如下图紫框中就是已经上传的文件，然后在蓝框中补充说明一下**。最后可以点击绿色的 `Commit changes` 来进行提交了
|
||||
|
||||
- 获取网站源码
|
||||
|
||||
|
||||
```bash
|
||||
git clone https://github.com/sipeed/sipeed_wiki.git
|
||||
```
|
||||
仓库管理员看到后会根据蓝框中的说明把文档移植到正确的位置。
|
||||
|
||||
- 安装对应插件
|
||||
|
||||
```bash
|
||||
cd sipeed_wiki
|
||||
teedoc install
|
||||
```
|
||||
- 本地构建网站
|
||||
|
||||
```bash
|
||||
teedoc serve
|
||||
```
|
||||
|
||||
然后访问 [http://127.0.0.1:2333](http://127.0.0.1:2333) 可以查看构建的网页
|
||||
|
||||
## 添加文档
|
||||
|
||||
一般来说文档都位于根目录下面的 docs 文件夹里面。
|
||||
|
||||
对于想要添加的文档在合适的对应目录下面编写完毕后，再在对应目录的 sidebar 文件中合适的位置添加后，可在网页中相应的位置看到相关的文档
|
||||
|
||||
然后可以在本地构建的网站中查看效果。
|
||||
|
||||
如果自己觉得已经完成的话可以提交 PR ，我们看到后会及时合并进去。
|
||||
> 感谢参与建设开源文档
|
||||
BIN
share_docs/zh/assets/added.png
Normal file
|
After Width: | Height: | Size: 57 KiB |
BIN
share_docs/zh/assets/commit.png
Normal file
|
After Width: | Height: | Size: 27 KiB |
BIN
share_docs/zh/assets/edit_github_page.png
Normal file
|
After Width: | Height: | Size: 16 KiB |
BIN
share_docs/zh/assets/edit_page.png
Normal file
|
After Width: | Height: | Size: 20 KiB |
BIN
share_docs/zh/assets/edit_preview.png
Normal file
|
After Width: | Height: | Size: 33 KiB |
BIN
share_docs/zh/assets/github_pages.png
Normal file
|
After Width: | Height: | Size: 48 KiB |
BIN
share_docs/zh/assets/upload.png
Normal file
|
After Width: | Height: | Size: 33 KiB |
@@ -1,29 +1,43 @@
|
||||
# 编辑文档
|
||||
|
||||
现在的文档仓库数量庞大，存在着一些编者都没有注意的错误。当读者发现错误的时候，可以进行修改。
|
||||
现在的文档仓库数量庞大，存在着一些编者都没有注意的错误。
|
||||
当读者发现错误的时候，可以进行修改。
|
||||
|
||||
- 进入需要修改的文档页面，点击 “编辑本页”
|
||||
这里是直接链接到存放 wiki 源码的 GitHub 仓库（进入比较慢或者404 的时候，需要挂上代理）
|
||||
## 定位文件
|
||||
|
||||
|
||||
进入需要修改的文档页面，点击 “编辑本页”
|
||||
|
||||
- 登录 GitHub 账号
|
||||
在右上角进行 GitHub 账号登录/注册操作
|
||||
|
||||
|
||||
|
||||
就会跳转到想要修改页面所在的 github 原文件位置。~~github 上不去的话很正常~~
|
||||
|
||||
- 修改文档
|
||||
点击文本框中的 编辑 图标，就会直接对 源码 进行修改，这里使用的 markdown 进行编写的，如果不是知道如何使用 markdown ，请自行百度教程。
|
||||
|
||||
|
||||
|
||||
## 登录 github
|
||||
|
||||
编辑框为以下形式，文档中图片为连接位置尽量不要使用外链，如需使用，提交pr的注明一下，会由管理员统一同步到仓库中
|
||||
点击 github 页面右上角的 `sign in` 来登陆账号
|
||||
|
||||
|
||||
|
||||
|
||||
- 提交 PR
|
||||
文档修改结束之后，在编辑框下进行提交。根据提示填入修改备注信息
|
||||
## 修改文档
|
||||
|
||||
|
||||
|
||||
|
||||
仓库管理员看到之后，会在确认可用之后合并到仓库中。
|
||||
点击上图所框出的图标来编辑当前文件，就相当于直接对 wiki 网页编辑了。
|
||||
文件主要以 markdown 为主，少部分为 ipynb 。
|
||||
|
||||
编辑页面如下所示，其中两个红框分别是 编辑文件 页面和 预览 页面。编辑时可以随时切换到预览页面来查看一下编辑结果
|
||||
|
||||
|
||||
|
||||
## 提交
|
||||
|
||||
文档修改完毕后，在编辑框最底下进行提交。
|
||||
可以在红框中简述修改信息，并且在蓝框中补充说明。
|
||||
也可以不进行说明直接点下方的绿色的 'Commit Changes'来进行提交
|
||||
|
||||
|
||||
|
||||
仓库管理员看到之后，会在确认可用之后合并到仓库中。
|
||||
|
||||
> 感谢参与建设开源文档
|
||||
@@ -1,9 +1,13 @@
|
||||
# 修改 wiki
|
||||
|
||||
有时候 wiki 文章中会有一些错误，或者有人有什么好的文章想分享。
|
||||
有时候 wiki 文章中会有一些错误，或者大家有什么好的文章想分享。
|
||||
|
||||
就可以按照下面的两种方法来更改 wiki 。
|
||||
|
||||
这里提供 修改 和 分享 文档得两种方式
|
||||
|
||||
- [**修改文档**](./change_doc.md) <--点它
|
||||
|
||||
- [**分享文档**](./add_doc.md) <--点它
|
||||
- [**添加文档**](./add_doc.md) <--点它
|
||||
|
||||
来一起把 wiki 建设的更好
|
||||