BitBook设定三部曲

2017年1月7日20:44:03

之前未接触过GitBook,这次任务可以让自己被动接触新东西,对于比较懒散的我而言挺好。

按照课程给定的参考链接开始接触GitBook。

1.设置权限

这一步上并没有看到教程里面提到的“Access to webhook”权限(如下图),不过先不管,继续下一步。

注:这一步里面需要降权限设定为"With access to private repositories",这样才能保证gitbook可以访问到私有仓库,比如从AIMinder里面fork过来的Py103

2.链接gitbook与github

如果当前已经登录了github,那么从第一步操作中的超链接进入时只需要按照提示操作已经在gitbook与github之间建立了链接。不过手册里面说明在gitbook当中要对应到某一个仓库地址。

当前的操作一直停留在Personal settings页面,在这个页面并不能找到在什么位置填写仓库地址,之后跳转到gitbook主页,进入gitbook创建流程:

成功创建一个gitbook之后在左侧的“github”选项里面可以选择需要同步的github仓库。

3.设置webhooks

设置完第二步之后,点击页面中的“Add Webhook”完成本次设置。

一个错误

2017年1月8日09:08:29

早上再看了下一份gitbook使用教程,意识到昨晚针对gitbook的尝试有些问题。

这个问题是不应该将gitbook的同步repository设定为Py103,这里面的区别在于:

  1. gitbook与github起始是俩相互独立的工具,一个管理代码,一个用来管理电子书。
  2. gitbook与github建立连接的主要目的在于将电子书的内容存放在github,而gitbook用来发布这些内容。

这样,我昨天将gitbook的同步仓库设定为“Py103”的行为将导致Py103当中的代码与电子书的内容放在了,显然会导致之后管理上的混乱。所以,我现在需要另外建设一个github仓库用来存放gitbook的内容。

真的需要另外再建设仓库吗?

不对的。因为当前的Py103的目录分布实际上就是按照电子书的结构涉及的,因此开智Py103教程设计的意图就是将Py103来作为gitbook的实验仓库的。

D:\LEARNING\GIT\PY103
├─Chap0
│  ├─note
│  └─project
├─Chap1
│  ├─note
│  └─project
├─Chap2
│  ├─note
│  └─project
├─Chap3
│  ├─note
│  └─project
├─Chap4
│  ├─note
│  └─project
├─Chap5
│  ├─note
│  └─project
├─Chap6
│  ├─.ipynb_checkpoints
│  ├─note
│  └─project
├─Chap7
│  ├─note
│  └─project
├─Chap8
│  ├─note
│  └─project
└─Chap9
    ├─note
    └─project

创设gitbook目录

2017年1月8日09:33:14

想明白上面这个问题之后,接下来的工作就好办了,按照如下次序进行:

  1. 依照Py103的目录先创建gitbook目录结构,主要做法是新建SUMMARY.md,在里面写作目录结构。
  2. 将第0周的笔记拆分为多个md的文件,并在SUMMARY.md添加它们。

上面这两部设置完成之后的Py103根目录以及Py103/Chap0子目录的文件分布如下:

D:.
│  ISSUE_TEMPLATE.md
│  README.md
│  SUMMARY.md
│
├─Chap0
│  │  README.md
│  │
│  ├─note
│  │      Section1_CardPackageLearning.md
│  │      Section2_DifferenceBetweenPython2AndPython3.md
│  │      Section3_UseGitbook.md
│  │      Pic0_3_step1_gitbook_permission.jpg
│  │      Pic0_3_step2_add_repository_name.jpg
│  │      Pic0_3_step3_createnewbook.jpg
│  │      Pic0_3_step4_addwebhook.jpg
│  │      Pic0_3_step4_selectrepository.jpg
│  │
│  └─project
│          ex19_python2.py
│          ex19_python3.py
│          ex20_example_file.txt
│          ex20_python2.py
│          ex20_python3.py
│          ex21_python2.py
│          ex21_python3.py
│          ex22.hello
│          ex23.hello
│          README.md
│
├─Chap1
│  │  README.md

在gitbook上预览,可以查看到想要的结果。

results matching ""

    No results matching ""