https://github.com/explooosion/gitbook-boilerplate
Please Fork this repo if you want to start your own book with Gitbook
https://github.com/explooosion/gitbook-boilerplate
boilerplate demo example gitbook
Last synced: 10 months ago
JSON representation
Please Fork this repo if you want to start your own book with Gitbook
- Host: GitHub
- URL: https://github.com/explooosion/gitbook-boilerplate
- Owner: explooosion
- License: mit
- Created: 2018-04-15T18:38:24.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-15T19:34:28.000Z (almost 8 years ago)
- Last Synced: 2025-01-24T22:11:48.636Z (about 1 year ago)
- Topics: boilerplate, demo, example, gitbook
- Language: HTML
- Homepage: http://robby570.tw/gitbook-boilerplate/
- Size: 641 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gitbook Boilerplate
[](https://github.com/explooosion/gitbook-boilerplate)
[](https://github.com/explooosion/gitbook-boilerplate)
[](https://github.com/explooosion/gitbook-boilerplate)
### Online Demo
👉 [Start Reading](http://robby570.tw/gitbook-boilerplate/)
### Global Installation
Installation is done using the
[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
```bash
npm install -g gitbook-cli
```
```bash
gitbook install
```
### Run Gitbook
#### View
Using `dev` to run local [http://192.168.0.100:8080](http://192.168.0.100:8080)
```bash
npm run dev
```
If you want to watch files, please remove the folder `_book` after running the script `dev`.
> from [git serve can't restart when file changes #1379](https://github.com/GitbookIO/gitbook/issues/1379)
#### Image
You can put images to [imgur](https://imgur.com/), please install [vscode-imgur](https://github.com/MaxfieldWalker/vscode-imgur).
> Add your imgur key to `.vscode` / `settings.json`
> Hotkey `Ctrl` + `Alt` + `V`
### Build To HTML
Using `build` to compile the files into `docs`.
```bash
npm run build
```
### Convert To PDF
Using `pdf` to export the PDF format.
```bash
npm run pdf
```
> If your OS is Windows, please download [Calibre](https://calibre-ebook.com/download_windows).
### Use Disqus
Input your shortname into `book.json`,
then you can use the [disqus](https://disqus.com/) plugin.