7 像命令行一样使用 GitHub 链接
使用 GitHub 自带的 UI 浏览也还不错,但有时直接在 URL 中输入是最快的方法。比如,我想跳转到我正在编辑的分支并和 master
进行对比,就可以在项目名称后面接上 /compare/branch-name
。
与选中分支的对比页将会显示出来:
以上就是和 master 分支的差异,如果想要合并分支的话,只需要输入 /compare/integration-branch...my-branch
即可。
你还可以利用快捷键达到同样的效果,使用 ctrl + L
或者 cmd + L
可以将光标移动到 URL
上(至少在 Chrome 中可以)。 加上浏览器的自动补全 —— 你就可以在两个分支之间轻松切换了。
8 在Issues创建列表
你想在你的 issue 中看到复选框列表吗?
你想在查看 issue 列表是它们以好看的 2 of 5
进度条呈现吗?
太好了!你可以用以下语法来创建一个交互性的复选框:
- [ ] Screen width (integer) - [x] Service worker support - [x] Fetch support - [ ] CSS flexbox support - [ ] Custom elements
是由一个空格、中横线、空格、左括号、空格(或者是 X )、右括号、空格以及一些文本组成。
你甚至可以真正的 选中/取消 这些复选框!基于某些原因,对于我来说你看起来像是技术魔力。是真的能够选中这些复选框!甚至它还更新了底层源码。
ps:以下包括第九点 基于GitHub的项目面板 由于用的不多就没有翻译。
10 GitHub wiki
作为一个像维基百科那样的非结构化的页面集合, GitHub Wiki
的供给(我把它称之为 Gwiki
) 是一个非常棒的功能。
对于结构化的页面来说 —— 例如你的文档:不能说这个页面是其他页面的子页面,或则是有 “下一节”,“上一节” 这样的便捷按钮。并且 Hansel
和 Gretel
也没有,因为结构化页面并没有 breadcrumbs
这样的设计。
我们继续,让 Gwiki 动起来,我从 NodeJS
的文档中复制了几页来作为 wiki 页面。然后创建了一个自定义侧边栏,帮助我更好地模拟一些实际的目录结构。尽管它不会突出显示你当前的页面位置,但侧边栏会一直存在。
这些链接需要你手动维护,但总的来说,我认为它可以做得很好。 如果需要的话可以看看。
虽然它与 GitBook
( Redux 文档所使用的)或者是定制网站相比仍有差距。但在你的 repo 中它有 80% 完全值得信赖的。
我的建议是: 如果你已经有多个 README.md
文件,并且想要一些关于用户指南或更详细的文档的不同的页面,那么你应该选择 Gwiki
。
如果缺乏结构化/导航开始让你不爽的话,那就试试其他的吧。