内容简介:HonKit is building beautiful books using GitHub/Git and Markdown.HonKit documentation is built by HonKit!
HonKit
HonKit is building beautiful books using GitHub/Git and Markdown.
Documentation and Demo
HonKit documentation is built by HonKit!
Quick Start
Installation
- Requirement: Node.js
The best way to install HonKit is via NPM or Yarn .
$ npm init --yes $ npm install honkit --save-dev
Create a book
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 .
Features
- Write using Markdown or AsciiDoc
- Output as a website or ebook (pdf, epub, mobi)
- Multi-Languages
- Lexicon / Glossary
- Cover
- Variables and Templating
- Content References
- Plugins
- Beautiful default theme
Fork of GitBook
HonKit is a fork of GitBook (Legacy) . GitBook (Legacy) is deprecated and inactive project.
HonKit aim to smooth migration from GitBook (Legacy) to HonKit.
Compatibility with GitBook
- Almost plugins work without changes!
- Support
gitbook-plugin-*
packagesnpm install gitbook-plugin-<example> --save-dev
Differences with GitBook
- Node.js 14+ supports
- Improve
build
/serve
performance-
honkit build
: use file cache by default -
honkit serve
: 28.2s → 0.9s in examples/benchmark - Also, support
--reload
flag for force refresh
-
- Improve plugin loading logic
- Reduce cost of finding
honkit-plugin-*
andgitbook-plugin-*
- Support
honkit-plugin-*
and@scope/honkit-plguin-*
(GitBook does not support a scoped module)
- Reduce cost of finding
- Remove
install
command- Instead of it, just use
npm install
oryarn install
- Instead of it, just use
- Remove
global-npm
dependency- You can use HonKit with another npm package manager like
yarn
- You can use HonKit with another npm package manager like
- Update dependencies
- Upgrade to nunjucks@2 etc...
- It will reduce bug
- TypeScript
- Monorepo codebase
- Easy to maintain
Migration from GitBook
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 work!
Benchmarks
honkit build
benchmark:
Licensing
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.
Sponsors
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持 码农网
猜你喜欢:本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。
精通JavaScript+jQuery
曾顺 编著 / 人民邮电出版社 / 2008-9 / 59.00元
随着Ajax技术的不断风靡,其核心技术JavaScript越来越受到人们的关注,各种JavaScript的框架层出不穷。jQuery作为JavaScript框架的优秀代表,为广大开发者提供了诸多便利。 本书从介绍JavaScript的基础知识开始,围绕标准Web的各项技术予以展开,通过大量实例对JavaScript、CSS、DOM、Ajax等 Web关键技术进行深入浅出的分析,主要内容包括J......一起来看看 《精通JavaScript+jQuery》 这本书的介绍吧!