Skip to content

HbCollaborateWikiandCode

ishanshan edited this page Mar 25, 2018 · 7 revisions

项目仓库 wiki 初始化&优雅使用指南

GitHub wiki 适合积累需复用、持续改动的文字成果,加之有 sidebar ,非常适合非技术类项目共创。不过最好同步到本地来编辑。

本文档供你了解优雅初始化及使用 wiki 。wiki 初始化一般不超过 2 分钟,跟着下图操作,相信你很快也能搞定。

注意:如果文中图片无法显示,可刷新页面耐心等待,或点击图片右键选择在新标签打开来查看。

初始化 wiki

  1. 进入仓库 wiki 界面,创建 wiki home page(如下图)。如果菜单栏没有 wiki 选项,需先到菜单栏最右的 setting 处,勾选 wiki

    wikicreate.png

    wikicreatehomepage.png

  2. 创建 wiki sidebar :

    wikicreatesidebar.png

    wikicreatesidebarpage.png

至此,wiki 初始化已完成。你可以在网页继续完善 wiki,但难免遇到网络不稳、保存不上。如果你不想哪天冷不丁白费了功夫,那就在本地编辑这些内容,再同步到云端吧~

把 wiki 同步到本地来编辑

  1. 同步 wiki 到本地:

    wikiclone1.png

    点击后 clone in desktop 后的操作方法,类似把 code 内容同步到本地编辑。详见 HbAssignmentHandup · OpenMindClub/Share Wiki 的 1.1 & 1.2 视频。

  2. wiki 同步到本地后,在其路径下创建你项目文档,比如下述举例。文档名称最好用英文。即使还没内容也无妨,可先创建空文档,把整个项目框架搭起来,以便同伴知晓要共创哪些东西。

     HbCollaborate.md                  InfoShow.md                       LogMeeting171226PrepareforShow.md
     Home.md                           InfoShowQA.md                     ReviewFinalProject_Serena333.md
     IndexReference.md                 InfoVedio.md                      ReviewFinalProject_ishanshan.md
     InfoLost.md                       LogMeeting171205BrandName.md      ReviewFinalProject_yixiu.md
     InfoProjectIdea.md                LogMeeting171213VedioIdea.md      _Sidebar.md
    
  3. 打开 _Sidebar.md 文档,更新 sidebar 内容,让你的项目资源一目了然。比如:

    wikisamplesidebar1.png

    如看不清上述图片,可点击图片右键选择在新标签打开,查看大图。

    注意:如果你的文档名是中文,那就没办法使用文档名做相对链接了,只能用绝对链接(其页面地址)。

  4. 把这些内容同步到云端,通知伙伴一起共创~

当然,如果你实在不想用 wiki, 用 code 来承载这些内容也 OK 。操作方式类似 wiki ,欢迎你探索后一起增补本指南哦。

想在 GitHub 共创更畅快,还可查看 GitHub 协作注意事项 避免一些平添烦恼的协作姿势。

CHANGELOG

  • 180325 闪闪更改图片质量
  • 171207 闪闪创建
Clone this wiki locally