GitbookIO/gitbook

Stars
26,857
Rank 741 (Top 0.02 %)
Language
TypeScript
License
GNU General Publi...
Created over 10 years ago
Updated 3 months ago

GitbookIO/gitbook

GitbookIO

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

The open source frontend for GitBook doc sites

⚠️ Deprecation warning:

As the efforts of the GitBook team are focused on the GitBook.com platform, the CLI is no longer under active development.
All content supported by the CLI are mostly supported by our GitBook.com / GitHub integration.
Content hosted on the legacy.gitbook.com will continue working until further notice. For differences with the new version, > check out our documentation.

Join our GitHub community to stay up to date with the latest news at GitBook.

GitBook

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.

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.

javascript

GitBook teaching programming basics with Javascript

nuts

🌰 Releases/downloads server with auto-updater and GitHub as a backend

gitbook-cli

GitBook's command line interface

git

ProGit Book Fork generated using GitBook

markup-it

JavaScript library to parse and serialize markup content (Markdown and HTML)

markdown

Learn how to use Markdown

kramed

A markdown (kramdown compatible) parser and compiler. Built for speed. (Fork of marked)

theme-default

Default theme for GitBook

rousseau

Lightweight proofreader in JS

theme-api

Theme for publishing a beautiful API documentation with GitBook

community

GitBook's official community page

gitbook-convert

CLI to convert an existing document to a GitBook.

slate-edit-table

Slate plugin for table edition

slate-edit-list

A Slate plugin to handle keyboard events in lists.

proxies-on-cloudflare

Proxies in Cloudflare Workers

plugin-mathjax

MathJAX plugin for GitBook

plugin-autocover

Generate a cover for the book

styleguide

GitBook.com HTML/CSS Style Guide

repofs

Simple and unified API to manipulate Git repositories

hunspell-spellchecker

Parse and use Hunspell dictionaries in Javascript

micro-analytics

A micro multi-website analytics database service designed to be fast and robust, built with Go and SQLite.

integrations

Toolkit to build integrations on GitBook

plugin

Sample plugin for GitBook

filterable

Parse and convert GitHub-like search queries in Node.JS

plugin-katex

Math typesetting using KaTex

example

Simple GitBook example

plugin-exercises

Interactive exercices in a gitbook

react-rich-diff

React component to render rich diff between two documents (Markdown, HTML)

plugin-disqus

Disqus comments on your books

plugin-ga

Google Analytics tracking for your book

git-sync-normalization

A repository that shows how we translate every content block to markdown.

slate-edit-code

A Slate plugin for code block editing

theme-faq

Theme for publishing a FAQ or Knowledge base

node-gitbook-api

Node client library for the GitBook API

plugin-youtube

Plugin to insert youtube videos in a GitBook

tokenize-text

Javascript text tokenizer that is easy to use and compose.

slate-prism

A Slate plugin to highlight code blocks using PrismJS

plugin-codetabs

Multiple languages code blocks for GitBook

plugin-quizzes

Interactive quizzes in a gitbook

plugin-search

Search content in your book

plugin-algolia

Power search using Algolia

theme-official

GitBook theme for our own books

plugin-github

Display a link to your GitHub repo in your gitbook

go-gitbook-api

GitBook API client in GO (golang)

slate-hyperprint

A library to convert Slate models to their slate-hyperscript representation

plugin-hints

GitBook plugin. Defines 4 types of styled hint blocks: info, danger, tip, working

go-github-webhook

A GitHub webhook handler written in Go

expect-firestore

API client and Jasmine matchers for the Firestore Rules API

plugin-puml

UML Diagrams rendering using PlantUML

node-opds

Node.js library to parse/generate OPDS feed

plugin-comment

Inline discussions integrated with gitbook.com

node-onix

Node.JS library to parse/generate ONIX XML files

slate-sugar

🍭 Create Slate documents using JSX.

bipbip

Benchmark runner for performance regression test suites

slate-lite-renderer

Fast renderer for read-only Slate documents

plugin-fontsettings

Font settings for GitBook website

github-api-signature

Node.js signature generator for GitHub API using a PGP key

isbn-utils

Javascript utilities to parse and normalize ISBNs

plugin-versions

Display a <select> with other versions of your gitbook

markdown-css

Minimalist stylesheet (CSS or Less) for markup output

plugin-scripts

Include scripts in your GitBook

plugin-sharing

Sharing button in toolbar for GitBooks

tokenize-english

Javascript tokenizer for english sentences

diskache

Lightweight Golang disk cache

mimedb

An extensive mime database in Go

DraftMirror

Draft.js-like API on top of ProseMirror

normall

Normall: normalize filenames, accents etc ... in JS

plugin-highlight

Default syntax highlighter for GitBook

unstated

Simple state management for react

services-slack

Slack notifications service

plugin-gist

Embed Gist in your book

monorepo

A big home for small repos

slate-edit-footnote

A Slate plugin to handle footnotes

lru-diskcache

A disk cache object that deletes the least-recently-used items

slate-edit-blockquote

A Slate plugin to handle keyboard events in blockquotes

public-docs

plugin-styles-sass

SASS custom stylesheets instead of CSS

node-epubcheck

Node wrapper for epubcheck

plugin-lunr

Backend for the search plugin using Lunr

geo-utils

Utilities to get countries, languages and US states

slate-trailing-block

Slate plugin to ensure a trailing block

eslint-config-gitbook

GitBook's ESLint config, following our styleguide

go-sqlpool

A high level pool for maintaining pools of *sql.DB databases (e.g: thousands of SQLite files)

syncgroup

Like golang's sync package but allows locking per groups of (string) keys (e.g: syncgroup.MutexGroup)

plugin-infinitescroll

Infinite scrolling in your gitbook

node-tasqueue

Node.js job/task-queue library using disque

plugin-livereload

Live reloading for your gitbook

plugin-tonic

Embed Tonic notebook into your GitBook

markdown-tools

A small CLI interface to kramed with lots of useful markdown tools (like go's "go fmt", lexing, rendering ...)

openapi-autodoc

Generate a GitBook Space from an OpenAPI spec

slate-no-empty

Slate plugin to prevent the document from being empty

plugin-mixpanel

Mixpanel tracking for your gitbook

brightml

Smart utility rendering markdown-ready HTML

html2hs

Convert HTML to hyperscript for virtual-dom

kramed-text-renderer

Renderer for kramed outputting plain text that can easily be fed to a search indexer/tokenizer/...

plugin-sitemap

Generate a sitemap for the gitbook website

firebase-apparatus

Lightweight implementation of firebase-tools as a Node module

licenses-utils

Utilities to detect licenses from project

example-visitor-authentication

Minimalist NodeJS application for "Visitor Authentication"

plugin-superscript

Use superscript in your content