gitbk

GitBook

This is a fork of GitBook.

You can compare all changes between this fork and the original version

The changes are:

• allow to run this npm module as a CLI (without installing gitbook-cli)
• fix trailing slash for directories
• provide package-lock.json
• fix critical vulnerabilities
• allow to use gitbook plugins which uses npm namespaces/scopes
  • by using --scope your-namesapce option for the build subcommand
• BREAKING CHANGE: don't rewrite URLs starting with / or ..

Some examples:

link (md)	output (HTML)	target needs to exist in the gitbook
/foo/bar	/foo/bar	no
/foo/bar/	/foo/bar/	no
/foo/bar.html	/foo/bar.html	no
../foo	../../foo	no
../foo/	../../foo/	no
../foo/bar.html	../foo/bar.html	no
plugins	plugins	no
plugins/	plugins/	no
plugins/README.md	plugins/	yes

Motivation

The original project is not maintained anymore. Even no security fixes are merged.
The main reason for this fork is the handling of links. If you use GitBook to build pages distributed accross multiple teams and repositories but still want to host all of them under one domain you cannot use crosslinks because the original version of GitBooks rewrites URLs which are starting with / or pointing to directories outside of the book.json via ../.

Install

Original gitbook uses gitbook-cli to install and manage versions. But gitbook-cli only works with official gitbook release. This fork is published in another scope (timaschew/gitbook) so it's unable to be managed by gitbook-cli. It needs to be explicitly installed inside a book.

Before you start, make sure Node.js and npm is on your system.

You can either install the module globally or locally in an existing project with an package.json file.

npm install gitbk -g

If you don't use global installation, use ./node_modules/.bin/gitbk or npx gitbk to invoke the CLI

mkdir my-new-book
cd my-new-book
gitbk init
gitbk build

---

Original README

GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc). Here is an example: Learn Javascript.

You can publish and host books easily online using gitbook.com. A desktop editor is also available.

Check out the GitBook Community Slack Channel, Stay updated by following @GitBookIO on Twitter or GitBook on Facebook.

Complete documentation is available at toolchain.gitbook.com.

Getting started

GitBook can be used either on your computer for building local books or on legacy.gitbook.com for hosting them. To get started, check out the installation instructions in the documentation.

Usage examples

GitBook can be used to create book, public documentation, enterprise manual, thesis, research papers, etc.

You can find a list of real-world examples in the documentation.

Help and Support

We're always happy to help out with your books or any other questions you might have. You can ask a question on the following contact form at gitbook.com/contact or signal an issue on GitHub.

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

Publish your book

The platform legacy.gitbook.com is like an "Heroku for books": you can create a book on it (public, or private) and update it using git push.

Licensing

GitBook is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.