{"id":13395348,"url":"https://github.com/honkit/honkit","last_synced_at":"2025-05-10T07:48:07.233Z","repository":{"id":37346032,"uuid":"272002678","full_name":"honkit/honkit","owner":"honkit","description":":book: HonKit is building beautiful books using Markdown - Fork of GitBook","archived":false,"fork":false,"pushed_at":"2025-05-04T06:10:31.000Z","size":81241,"stargazers_count":3196,"open_issues_count":61,"forks_count":240,"subscribers_count":33,"default_branch":"master","last_synced_at":"2025-05-08T04:33:47.617Z","etag":null,"topics":["asciidoc","book","ebook","gitbook","honkit","javascript","markdown","plugin"],"latest_commit_sha":null,"homepage":"https://honkit.netlify.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/honkit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-06-13T12:16:48.000Z","updated_at":"2025-05-06T01:41:44.000Z","dependencies_parsed_at":"2023-12-29T23:02:02.289Z","dependency_job_id":"b90239c8-8872-41cb-b58d-9438a0db7b97","html_url":"https://github.com/honkit/honkit","commit_stats":{"total_commits":3167,"total_committers":148,"mean_commits":21.39864864864865,"dds":0.3369119040101042,"last_synced_commit":"9dcd51c588177ee3a684788c633a67b82dea82a5"},"previous_names":["githon/githon"],"tags_count":69,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/honkit%2Fhonkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/honkit%2Fhonkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/honkit%2Fhonkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/honkit%2Fhonkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/honkit","download_url":"https://codeload.github.com/honkit/honkit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253112073,"owners_count":21856069,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asciidoc","book","ebook","gitbook","honkit","javascript","markdown","plugin"],"created_at":"2024-07-30T17:01:53.438Z","updated_at":"2025-05-08T22:31:18.052Z","avatar_url":"https://github.com/honkit.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","E-books","book","网站生成与排版","Uncategorized"],"sub_categories":["Programming","电子书","Uncategorized"],"readme":"# HonKit\n\nHonKit is building beautiful books using GitHub/Git and Markdown.\n\n![HonKit Screenshot](./honkit.png)\n\n## Documentation and Demo\n\nHonKit documentation is built by HonKit!\n\n- \u003chttps://honkit.netlify.app/\u003e\n\n## Quick Start\n\n### Installation\n\n- Requirement: [Node.js](https://nodejs.org) [LTS](https://nodejs.org/en/about/previous-releases) version\n\nThe best way to install HonKit is via **NPM** or **Yarn**.\n\n```\n$ npm init --yes\n$ npm install honkit --save-dev\n```\n\n⚠️ Warning:\n\n- If you have installed `honkit` globally, you must install each plugins globally as well\n- If you have installed `honkit` locally, you must install each plugins locally as well\n\nWe recommend installing `honkit` locally.\n\n### Create a book\n\nHonKit can set up a boilerplate book:\n\n```\n$ npx honkit init\n```\n\nIf you wish to create the book into a new directory, you can do so by running `honkit init ./directory`\n\nPreview and serve your book using:\n\n```\n$ npx honkit serve\n```\n\nOr build the static website using:\n\n```\n$ npx honkit build\n```\n\nYou can start to write your book!\n\nFor more details, see [HonKit's documentation](https://honkit.netlify.app/).\n\n## Docker support\n\nHonkit provide docker image at [honkit/honkit](https://hub.docker.com/r/honkit/honkit).\n\nThis docker image includes built-in dependencies for PDF/epub.\n\n```\ndocker pull honkit/honkit\ndocker run -v `pwd`:`pwd` -w `pwd` --rm -it honkit/honkit honkit build\ndocker run -v `pwd`:`pwd` -w `pwd` --rm -it honkit/honkit honkit pdf\n```\n\nFor more details, see [docker/](./docker/).\n\n## Usage examples\n\nHonKit can be used to create a book, public documentation, enterprise manual, thesis, research papers, etc.\n\nYou can find a list of [real-world examples](https://honkit.netlify.app/examples.html) in the documentation.\n\n## Features\n\n* Write using [Markdown](https://honkit.netlify.app/syntax/markdown.html) or [AsciiDoc](https://honkit.netlify.app/syntax/asciidoc.html)\n* Output as a website or [ebook (pdf, epub, mobi)](https://honkit.netlify.app/ebook.html)\n* [Multi-Languages](https://honkit.netlify.app/languages.html)\n* [Lexicon / Glossary](https://honkit.netlify.app/lexicon.html)\n* [Cover](https://honkit.netlify.app/ebook.html)\n* [Variables and Templating](https://honkit.netlify.app/templating/)\n* [Content References](https://honkit.netlify.app/templating/conrefs.html)\n* [Plugins](https://honkit.netlify.app/plugins/)\n* [Beautiful default theme](./packages/@honkit/theme-default)\n\n## Fork of GitBook\n\nHonKit is a fork of [GitBook (Legacy)](https://github.com/GitbookIO/gitbook).\n[GitBook (Legacy)](https://github.com/GitbookIO/gitbook) is [deprecated](https://github.com/GitbookIO/gitbook/commit/6c6ef7f4af32a2977e44dd23d3feb6ebf28970f4) and an inactive project.\n\nHonKit aims to smooth the migration from GitBook (Legacy) to HonKit.\n\n### Compatibility with GitBook\n\n- Almost all plugins work without changes!\n- Support `gitbook-plugin-*` packages\n    - You should install these plugins via npm or yarn\n    - `npm install gitbook-plugin-\u003cexample\u003e --save-dev`\n\n### Differences with GitBook\n\n- Node.js 14+ supports\n- Improve `build`/`serve` performance\n    - `honkit build`: use file cache by default\n    - `honkit serve`: 28.2s → 0.9s in [examples/benchmark](examples/benchmark)\n    - Also, support `--reload` flag for force refresh\n- Improve plugin loading logic\n    - Reduce cost of finding `honkit-plugin-*` and `gitbook-plugin-*`\n    - Support `honkit-plugin-*` and `@scope/honkit-plugin-*` (GitBook does not support a scoped module)\n- Remove `install` command\n    - Instead of it, just use `npm install` or `yarn install`\n- Remove `global-npm` dependency\n    - You can use HonKit with another npm package manager like `npm` or `yarn`\n- Update dependencies\n    - Upgrade to nunjucks@2, highlight.js etc...\n    - It will reduce bugs\n- TypeScript\n    - Rewritten by TypeScript\n- Monorepo codebase\n    - Easy to maintain\n- [Docker support](./docker)\n\n### Migration from GitBook\n\nReplace `gitbook-cli` with `honkit`.\n\n```\nnpm uninstall gitbook-cli\nnpm install honkit --save-dev\n```\n\nReplace `gitbook` command with `honkit` command.\n\n```diff\n  \"scripts\": {\n-    \"build\": \"gitbook build\",\n+    \"build\": \"honkit build\",\n-    \"serve\": \"gitbook serve\"\n+    \"serve\": \"honkit serve\"\n  },\n```\n\nAfter that, HonKit just works!\n\nExamples of migration:\n\n- [Add a Github action to deploy · DjangoGirls/tutorial](https://github.com/DjangoGirls/tutorial/pull/1666)\n- [Migrate from GitBook to Honkit · swaroopch/byte-of-python](https://github.com/swaroopch/byte-of-python/pull/88)\n- [replace Gitbook into Honkit · yamat47/97-things-every-programmer-should-know](https://github.com/yamat47/97-things-every-programmer-should-know/pull/2)\n- [Migrate misp-book from GitBook to honkit](https://github.com/MISP/misp-book/pull/227)\n\n## Benchmarks\n\n`honkit build` benchmark:\n\n- \u003chttps://honkit.github.io/honkit/dev/bench/\u003e\n\n## Licensing\n\nHonKit is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text.\n\nHonKit is a fork of [GitBook (Legacy)](https://github.com/GitbookIO/gitbook).\nGitBook is licensed under the Apache License, Version 2.0.\n\nAlso, HonKit includes [bignerdranch/gitbook](https://github.com/bignerdranch/gitbook) works.\n\n## Sponsors\n\n\u003ca href=\"https://www.netlify.com\"\u003e\n\u003cimg src=\"https://www.netlify.com/img/global/badges/netlify-color-bg.svg\" alt=\"Deploys by Netlify\" /\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhonkit%2Fhonkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhonkit%2Fhonkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhonkit%2Fhonkit/lists"}