Giter Club home page Giter Club logo

gitbook-template's Introduction

TITLE OF YOUR BOOK

This is a template for writing books with gitbook. Grundfile.js was heavily inspired by the JavaScript book at https://github.com/GitbookIO/javascript

Pre-Requisites

$ sudo npm install -g gitbook gitbook-pdf grunt
$ sudo npm install gitbook-plugin-disqus gitbook-plugin-richquotes grunt-gitbook grunt-gh-pages grunt-contrib-clean
$ gitbook serve
```

Notice on older gitbook versions
========

Please use at least gitbook V0.4.2 or higher. Otherwise, changed links in book.js won't work.

If you want to install gitbook in version 0.4.2, type

$ sudo npm install -g [email protected]



Customization
========

Adapt book.json to your needs.

**Note:** shortName for disqus plugins equals to the shortname of your http://diqus.com configuration.

Please finde documentation for the richquote Plugin at https://github.com/erixtekila/gitbook-plugin-richquotes

Build the book with grunt
======

With grunt the book can be published directly to a gh-pages branch on your github repo:

$ grunt publish



License
======

This book is published by the [following license](LICENSE.md).

gitbook-template's People

Contributors

bjoernschotte avatar

Watchers

James Cloos avatar Probably Brian 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.