电竞比分网-中国电竞赛事及体育赛事平台

分享

將Gitbook上的書籍發(fā)布在GitHubPages上

 RyzeYang 2021-05-10

GitBook 是一個基于 Node.js 的命令行工具,可使用 Markdown 來制作精美的電子書.

但是Gitbook由于網(wǎng)絡(luò)問題,許多其他人發(fā)布的項目不能直接查看,或者保存.但是我們可以通過Github將fork Gitbook 源碼到自己的Github,并設(shè)置Github Pages 頁面訪問, 來實現(xiàn)保存Gitbook項目的目的.

GitHub Pages 簡單說就是一個可以托管靜態(tài)網(wǎng)站的 Git 項目,支持使用 markdown 語法以及 Jekyll 來構(gòu)建,或者直接使用已經(jīng)生成好的靜態(tài)站點。我們就可以使用GitPages搭建自己的個人博客. 這是我使用GitPages搭建的個人博客.

由于 gitbook 書籍可以通過 gitbook 本地構(gòu)建出 site 格式,所以可以直接將構(gòu)建好的書籍直接放到 GitHub Pages 中托管,之后,可以通過如下地址訪問書籍:

<username>./<project>

例如:這本書中使用的例子 'test’ 項目可以通過地址:chengweiv5./test 來訪問。

當(dāng)訪問 meiko-zhang./test 時,會訪問 meiko-zhang/test 項目的 gh-pages 分支的內(nèi)容,所以需要為項目創(chuàng)建一個 gh-pages 分支,并且將靜態(tài)站點內(nèi)容放入其中。也就是說,test 項目將有如下兩個分支:

  • master, 保存書籍的源碼
  • gh-pages, 保存書籍編譯后的 HTML 文件

安裝GitBook

我們需要通過Github上的源碼生成對應(yīng)的HTML才能在Github Pages上訪問.所以需要安裝Gitbook.
請參考GitBook的安裝和使用方法.

我們的操作中還需要使用到Git.
請參考Git的安裝和使用 .

編譯書籍

首先,創(chuàng)建一個文件夾,用戶來存放要編譯的書籍.

mkdir book && cd book

將需要編譯的數(shù)據(jù)源碼倉庫從Github上clone到當(dāng)前文件夾中.

git clone git@github.com:meiko-zhang/test.git

使用 gitbook build 將書籍內(nèi)容輸出到默認(rèn)目錄,也就是當(dāng)前目錄下的 _book 目錄。

gitbook build

build 失敗的可能是配置出現(xiàn)了錯誤,可以根據(jù)提示修改book.json 的配置信息.
注意:記得修改book.json后提交到github上.

git add book.json
git commit -m "update book.json"
git push -u origin master

創(chuàng)建 gh-pages 分支

執(zhí)行如下命令來創(chuàng)建分支,并且刪除不需要的文件:

git checkout --orphan gh-pages
git rm -f --cached -r .
git clean -df
rm -rf *~

現(xiàn)在,目錄下應(yīng)該只剩下 _book 目錄了,首先,忽略一些文件:

echo "*~" > .gitignore
echo "_book" >> .gitignore
git add .gitignore
git commit -m "Ignore some files"

然后,加入 _book 下的內(nèi)容到分支中:

cp -r _book/* .
git add .
git commit -m "Publish book"

上傳書籍內(nèi)容到 GitHub

現(xiàn)在,可以將編譯好的書籍內(nèi)容上傳到 GitHub 中 book 項目的 gh-pages 分支了,雖然這里還沒有創(chuàng)建分支,上傳和創(chuàng)建會一步完成!

git push -u origin gh-pages

現(xiàn)在,書籍的內(nèi)容已經(jīng)上傳到 GitHub 上,所以通過訪問 meik-zhang/test 就可以閱讀 test 這本書了!

參考此書籍,總結(jié)完善后發(fā)表本文,并將此本書發(fā)布在Github Pages上.

    本站是提供個人知識管理的網(wǎng)絡(luò)存儲空間,所有內(nèi)容均由用戶發(fā)布,不代表本站觀點。請注意甄別內(nèi)容中的聯(lián)系方式、誘導(dǎo)購買等信息,謹(jǐn)防詐騙。如發(fā)現(xiàn)有害或侵權(quán)內(nèi)容,請點擊一鍵舉報。
    轉(zhuǎn)藏 分享 獻(xiàn)花(0

    0條評論

    發(fā)表

    請遵守用戶 評論公約

    類似文章 更多