HonKit is building beautiful books using Markdown - Fork of GitBook
APACHE-2.0 License
HonKit is building beautiful books using GitHub/Git and Markdown.
HonKit documentation is built by HonKit!
The best way to install HonKit is via NPM or Yarn.
$ npm init --yes
$ npm install honkit --save-dev
⚠️ Warning:
honkit
globally, you must install each plugins globally as wellhonkit
locally, you must install each plugins locally as wellWe recommend installing honkit
locally.
HonKit can set up a boilerplate book:
$ npx honkit init
If you wish to create the book into a new directory, you can do so by running honkit init ./directory
Preview and serve your book using:
$ npx honkit serve
Or build the static website using:
$ npx honkit build
You can start to write your book!
For more details, see HonKit's documentation.
Honkit provide docker image at honkit/honkit.
This docker image includes built-in dependencies for PDF/epub.
docker pull honkit/honkit
docker run -v `pwd`:`pwd` -w `pwd` --rm -it honkit/honkit honkit build
docker run -v `pwd`:`pwd` -w `pwd` --rm -it honkit/honkit honkit pdf
For more details, see docker/.
HonKit can be used to create a book, public documentation, enterprise manual, thesis, research papers, etc.
You can find a list of real-world examples in the documentation.
HonKit is a fork of GitBook (Legacy). GitBook (Legacy) is deprecated and an inactive project.
HonKit aims to smooth the migration from GitBook (Legacy) to HonKit.
gitbook-plugin-*
packages
npm install gitbook-plugin-<example> --save-dev
build
/serve
performance
honkit build
: use file cache by defaulthonkit serve
: 28.2s → 0.9s in examples/benchmark
--reload
flag for force refreshhonkit-plugin-*
and gitbook-plugin-*
honkit-plugin-*
and @scope/honkit-plugin-*
(GitBook does not support a scoped module)install
command
npm install
or yarn install
global-npm
dependency
npm
or yarn
Replace gitbook-cli
with honkit
.
npm uninstall gitbook-cli
npm install honkit --save-dev
Replace gitbook
command with honkit
command.
"scripts": {
- "build": "gitbook build",
+ "build": "honkit build",
- "serve": "gitbook serve"
+ "serve": "honkit serve"
},
After that, HonKit just works!
Examples of migration:
honkit build
benchmark:
HonKit is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.
HonKit is a fork of GitBook (Legacy). GitBook is licensed under the Apache License, Version 2.0.
Also, HonKit includes bignerdranch/gitbook works.