Wiki 使用指南

https://blog.nebulas.io/wp-content/uploads/2018/12/medium-960x540.jpg

什么是星云Wiki:

星云Wiki是星云社区协作工具,星云社区成员以协作方式发布各种文档,包括技术文档、相关资料、社区动态等。每个社区成员都可根据自己兴趣参与到星云Wiki的维护中去,并受益于日益完善的星云Wiki。

如何参与Wiki维护:

首先你得有个GitHub账号。注册流程非常简单,1分钟内即可搞定。 https://blog.nebulas.io/wp-content/uploads/2018/12/%E6%9B%BF%E6%8D%A21-1200x642.jpg https://blog.nebulas.io/wp-content/uploads/2018/12/P6-1200x579.jpg

登录Github账号,打开星云Wiki页面就能参与编辑维护了。 https://blog.nebulas.io/wp-content/uploads/2018/12/P4-1200x586.jpg 星云Wiki中文界面,点击左下角“v.latest”,在弹出的界面可切换语言版本,下载不同格式的星云Wiki文档,非常方便。

下面进入实战状态:比如我要添加一条动态。打开星云动态菜单,进入动态页面。 https://blog.nebulas.io/wp-content/uploads/2018/12/P7-1200x589.jpg

点击右上角”Edit on GitHub”,进入GitHub界面。看到图中红圈内的小笔了吗,点击后正式进入文本编辑界面。 https://blog.nebulas.io/wp-content/uploads/2018/12/p8-1200x574.jpg

咦,怎么看起来跟我们平常的Word编辑界面不一样。 没错,星云Wiki的编辑需要使用Markdown语言,跟我们平常使用的Word不那么一样。 https://blog.nebulas.io/wp-content/uploads/2018/12/P9-1200x566.jpg

下面进入学习时间:编辑星云Wiki需要使用的Markdown种类很少,主要有以下几种。 一张图看懂Markdown主要用法。 https://blog.nebulas.io/wp-content/uploads/2018/12/%E6%9C%AA%E6%A0%87%E9%A2%98-1.png

如果嫌麻烦,网上有很多好用的在线Markdowan编辑器,非常好用。 这里推荐一款:

https://www.mdeditor.com/

好了,接下来我们开始编辑内容:添加一个链接。 https://blog.nebulas.io/wp-content/uploads/2018/12/P10-1200x535.jpg

编辑完毕,可以点击“Preview changes”预览效果。如果效果令你满意,进入下一步。 https://blog.nebulas.io/wp-content/uploads/2018/12/P11-1200x483.jpg

在页面底部,简要表述更新的内容(方便管理员审核),然后点击“Propose file change”。 https://blog.nebulas.io/wp-content/uploads/2018/12/p13-1200x466.jpg

嗯,还没完。还需要点击“create pull request”,提交推送请求。 https://blog.nebulas.io/wp-content/uploads/2018/12/p15-1200x551.jpg

最后再确认一下,再次点击“create pull request”。 https://blog.nebulas.io/wp-content/uploads/2018/12/P17-1200x723.jpg

看到下面这个界面,才算大功告成。这个时候,你需要做的就是等待管理员审核。 https://blog.nebulas.io/wp-content/uploads/2018/12/P18-1200x507.jpg

管理员审核过后,我们发现更新的内容,已经可以在星云Wiki上正常显示了。 恭喜你,你已经为星云Wiki作出了贡献,任何使用星云Wiki的人,将会看到你更新的内容,并受益于你。 https://blog.nebulas.io/wp-content/uploads/2018/12/p20-1200x467.jpg

在星云Wiki上创建新页面

更进一步,如果有社区小伙伴想创建新页面,那么具体该怎么操作呢?

其实两个字:简单。 比如有社区小伙伴想在“社区”菜单下面建立“活动”一页。 那么点击右上角“Edit on GitHub”,进入GitHub编辑页面。 https://blog.nebulas.io/wp-content/uploads/2018/12/P21-1200x521.jpg

选取要建立新页面所在的文件夹,点击进入。 https://blog.nebulas.io/wp-content/uploads/2018/12/P22-1200x582.jpg

这里需要稍微解释下,md后缀的文件,代表单页页面; README.rst,用来控制文件的排列顺序。

点击右上角的“Create new file”,创建新文件。 https://blog.nebulas.io/wp-content/uploads/2018/12/P23-1200x457.jpg

上面红框内容是给后台文件命名,下面红框内容是Wiki显示标题。 https://blog.nebulas.io/wp-content/uploads/2018/12/P24-1200x483.jpg

下面的流程是不是很熟悉,跟修改页面的流程一样。这里就不展开讲了。 https://blog.nebulas.io/wp-content/uploads/2018/12/P25-1200x453.jpg

这个只是完成了第一步,接下来我们要修改下文件名称添加到目录中去,并在此提交修改。 修改通过后,新页面就可以在Wiki页面正常显示了。 https://blog.nebulas.io/wp-content/uploads/2018/12/P29-1200x472.jpg

在添加目录的时候, 需要注意两点:

README.rst中文件名称要跟之前创建的文件名称保持一致, README.rst目录的排序决定着文件在星云Wiki最终的显示顺序。

好了,我们的简明星云Wiki教程到此结束了,赶快参与星云Wiki的维护吧!