如何用 gitbook 結合 markdown 寫一本開源書籍

直接進入正題。html

1. 安裝 gitbook 並寫書

首先,安裝。node

$ npm install -g gitbook-cli
複製代碼

若是你沒有 nodejs 環境,你就去官網下載安裝一下,安裝完就有 npm 命令了。webpack

新建一個目錄放書的內容,好比叫 webpack,這個目錄裏是放書的內容。git

$ mkdir webpack
$ cd webpack
複製代碼

而後初始化生成文件。github

$ gitbook init
複製代碼

生成了下面兩個文件。web

.
├── README.md
└── SUMMARY.md
複製代碼

其中 README.md 是放書的說明,SUMMARY.md 是放書的目錄。npm

看了個人內容,你應該就會明白如何寫的。瀏覽器

README.mdbash

# webpack 3 零基礎入門教程

最詳細,最簡單的零基礎 webpack 3 入門教程,人人都能學會。

原文發佈於個人我的博客:https://www.rails365.net

源碼位於:https://github.com/yinsigan/webpack-tutorial

電子版: [PDF](https://www.gitbook.com/download/pdf/book/yinsigan/webpack-3) [Mobi](https://www.gitbook.com/download/mobi/book/yinsigan/webpack-3) [ePbu](https://www.gitbook.com/download/epub/book/yinsigan/webpack-3)

### 聯繫我:

email: hfpp2012@gmail.com

qq: 903279182
複製代碼

SUMMARYmarkdown

# Summary

* [0. 開始](README.md)
* [1. 介紹](chapters/1.md)
* [2. 安裝](chapters/2.md)
* [3. 實現 hello world](chapters/3.md)
* [4. webpack 的配置文件 webpack.config.js](chapters/4.md)
* [5. 使用第一個 webpack 插件 html-webpack-plugin](chapters/5.md)
* [6. 使用 loader 處理 CSS 和 Sass](chapters/6.md)
* [7. 初識 webpack-dev-server](chapters/7.md)
複製代碼

目錄結構:

.
├── README.md
├── SUMMARY.md
└── chapters
    ├── 1.md
    ├── 2.md
    ├── 3.md
    ├── 4.md
    ├── 5.md
    ├── 6.md
    └── 7.md
複製代碼

在終端運行:

$ gitbook serve
複製代碼

這樣,能夠用瀏覽器打開 http://localhost:4000,一邊寫書,一邊看效果。

2. 把書的源碼放到 github 上

如今咱們準備把寫好的書,作成一個 git 倉庫,再放到 github 上。

$ git init
$ git add .
$ git commit -m "first commit"
複製代碼

新建一個文件 .gitignore

內容以下:

# Node rules:
## Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

## Dependency directory
## Commenting this out is preferred by some people, see
## https://docs.npmjs.com/misc/faq#should-i-check-my-node_modules-folder-into-git
node_modules

# Book build output
_book

# eBook build output
*.epub
*.mobi
*.pdf
複製代碼

這是爲了防止提交一些沒必要要的內容。

在 github 上新建一個倉庫叫 webpack-tutorial

$ git remote add origin git@github.com:yinsigan/webpack-tutorial.git
$ git push origin master
複製代碼

3. gitbook 新建書

進入 https://www.gitbook.com/ 網站。

如今能夠在線瀏覽了。

網址爲:https://www.gitbook.com/read/book/yinsigan/webpack-3

4. 綁定個性域名

你若是有你本身的域名也是能夠綁定過來的。

如今就能夠用 http://webpack.rails365.net/ 來訪問了。

完結。

相關文章
相關標籤/搜索