准备工作

在这里你可以了解参与此文档撰写的相关知识

想要编写Wiki,你需要一个Github账户和Vscode ^{其他可以支持MarkDown语言的也可以}

如果你还没有Github账户,请百度Github账户创建方法

编写

了解语言

Wiki文档是由MarkDown语言编写,你要对这种语言有所了解你才能写出一篇较为美观的文章

这里提供两个教学网站,里面内容大致相同,各取所需 Markdown官方教程    菜鸟教程

创建文件

打开Wiki的Github开源页面这里有许多文件,你只需要点击docs-CommunityPlayer或者是Other

点击右上角的Add ile选择Create new file

会有新页面出现,中间很大的区域就是代码编辑区,在这里你可以大展你的身手

在上面一点你会看到Name your file...这串英文,请在那里键入你创建的文档的名字,这个名字会显示在Wiki侧边栏标题上面,请谨慎填写,键入名字后再键入后缀.md

右边会有个绿色按键,这个就是你保存内容以及提交修改的关键,到时候会讲这个按键如何使用

编写格式

在编写属于你的文档时,请遵循MarkDown语言格式编写,否则系统会无法识别

在编写文件时,请在你的代码开头加上

---
sidebar_position: i
---

这串代码表示了你这篇文章的权重,通俗讲就是你文章在Wiki侧边栏的位置

"i"是一个常数值,你需要将"i"改成一个数字,"i"值的起始为0

该如何判断这个"i"值填什么,请打开Wiki找到你添加文档的索引,比如社区生态然后数里面包含多少文档,文档数-1就是"i"值的数字

---

当你完成了以上步骤时,你就可以开始编写你的文档了

PS:建议先在本地代码编辑器编辑完再复制代码到Github的编辑页面

提交

当你写完整篇文档时候你是否觉得很畅快,但先别急,如果你没进行这一步,就只是本地的一堆数据罢了

代码检查无误之后,请点击右上方绿色的Commit changes按钮

会弹出来一个窗口

* Commit message 提交消息(一般是不用修改)
* Extended description 描述(可以添加对你这篇文档的描述)
* Commit Email (不用更改,当你这篇文档时,系统就会给你这个邮箱发一个合并成功的信息)

点击绿色的按钮

跳转新页面,请找到

Tips:第一次提交请求的用户系统可能会让你创建一个分支在你的储存库里,按照系统提示做就好了

* Discuss and review the changes in this comparison with others. 

点击右边的 Create pull request 将你的文档合并请求发送给管理员

重复两次上面操作后

你会得到图示的情况

不用担心,这是正常的

当检查成功后应该会变成这样子

但是也有可能会 检查/部署 失败,你可以再看看你的内容修改一下,然后按照上面流程重新上传

至此为止,你就算是完成了创建文档的操作,剩下的就是等待管理员检查文档然后把你的文档合并到系统里去了

完结撒花

---

本文章遵循 CC BY-NC 4.0 协议 By Enigfrank