Skip to content

yunnysunny/gitbook

 
 

Repository files navigation

GitBook

Forked form official, we can run gitbook command directly by installing this package, plugin feature has not been supported now.

npm version build status David deps Test coverage node version

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

Complete documentation is available at gitbook.whyun.com.

Image

Getting started

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 discussions or signal an issue on GitHub.

Features

Publish your book

We can use the platforms such as Cloudflare Pages or Vercel to host you site generated by gitbook command and update it using git push.

Licensing

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

About

The open source frontend for GitBook doc sites

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%