GitBook Editor不能pull新Book时的处理
1.1 GitBook Editor不能获取新Book时的处理
1.1.1 概念说明
l GitBook Editor是客户端程序,用于内容的编辑与开发。
l Git是在CMD中执行的命令行,可以用于本地与服务端的同步操作(主要是首次从服务端拉取文件)。
1.1.2 场景说明
笔者在GitBook网站创建新的Book后,虽然在Gitbook Editor上可以看到该Book名称,但是单击书名后,却一致处于同步状态,无法进入编辑视图。查看本地存储目录,始终无法获取到相应的md文件。
1.1.3 解决办法
步骤 1 进入Gitbook Editor在本地的仓库目录。
Gitbook Editor的本地仓库目录如“C:\Users\wht\GitBook\Library\hting”所示,路径中“hting”是gitbook的用户名,即在本地仓库下为不同的gitbook账号分别创建了不同的存储目录。
步骤 2 在该目录下打开CMD或PowerShell窗口。
可以按住“shift”键并单击鼠标右键选择“在此次打开PowerShell”。
步骤 3 执行如下命令将gitbook服务端的Book文件同步到本地。
git clone https://git.gitbook.com/hting/my-api-book.git
上述命令中的路径即要同步的书的git路径。
在首次执行该命令时,会要求输入用户名和密码。
该命令执行结束后,即可在该目录下看到已pull下来的md文件,此时再打开Gitbook Editor就可以打开该Book了。
1.1.4 其它说明
除了在GitBook Editor中进行Book的编辑外,也可以使用其它Markdown编辑器直接编辑本地仓库下的md文件,然后通过命令或打开GitBook Editor将本地修改push到服务端。
1.2 Gitbook的文档结构说明
新创建一本Book时会生成两个md文件:
l README.md:可以理解为书的封面,默认为Book的第一个Topic。
l SUMMARY.md:用于定义Book的结构信息,将所有的md文件组织在一起,相当于Dita中的ditmap文件。
样例如下: