Git Product home page Git Product logo

gitbook-template's Introduction

Gitbook template

A Gitbook project template. This template has the following features,

  • PlamntUML support, using bitjourney/plantuml-service.
  • Ready for output PDF, EPUB and MOBI files.
  • Configured VSCode Tasks and Recommended extensions.

Dependencies

Required

Recommended

Usage

This Docker image for gitbook is manage markdown files in gitbook directory.

Initialize

Run the following command, to init your gitbook

$ curl https://codeload.github.com/HeRoMo/gitbook-template/zip/master -O
$ unzip master
$ mv gitbook-template-master your-gitbook-name
$ cd your-gitbook-name
$ docker-compose run --rm gitbook init

After init, gitbook directory will be created. If you want, modify gitbook/book.json for your gitbook.

Run local server

Run the following command, to start gitbook server.

$ docker-compose up

Open http://localhost:4000, after docker containers are started.

If you use Chrome browser with LiveReload extention, Reload automatically after modify *.md files.

Output PDF, EPUB and Mobi files

Run the following command, output PDF file as book.pdf

$ docker-compose run --rm gitbook pdf

Run the following command, output EPUB file as book.epub

$ docker-compose run --rm gitbook epub

Run the following command, output MOBI file as book.mobi

$ docker-compose run --rm gitbook mobi

Related Project

License

MIT. see LICENSE

gitbook-template's People

Contributors

heromo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.