Coder Social home page Coder Social logo

wbb's Introduction

Web Book Boilerplate

The easiest way of writing books for the web

With the Web Book Boilerplate you have the perfect place to start writing your book! It uses plain old markdown and generates a well structured HTML version of your written words. Since it's sitting on top of Pandoc and Grunt, you can easily make your books available for every platform!

The Web Book Boilerplate is also compatible with Leanpup, so even publishing your books works like a charm.

Features

  • Grunt to automate all the things!
  • Pandoc-based doc generation
  • Supports most used formats: mobi, epub, HTML
  • Compatible with Leanpub
  • Markdown-based
  • SASS support

Documentation

Checkout the full documentation right here!

Quickstart

Dependencies:

Clone the repository via git and install the npm dependencies

$ git clone https://github.com/PascalPrecht/wbb new-book
$ cd new-book
$ npm install

Ready to start! Write your book by creating chapter files in src/chapters. Add as many chapters as you want. wbb internally uses Pandoc; checkout their user guide for more information on writing markdown.

When finished writing build your book via

$ grunt wbb:html

to get a ready-to-publish html version.

Following formats are supported:

  • wbb:html - HTML version
  • wbb:epub - epub version
  • wbb:mobi - mobi version
  • wbb:rtf - rtf version

If you want to publish your book on leanpub.com, wbb is your friend. It provides a task to prepare your leanpub publishing process. After running

$ grunt wbb:leanpub

simply copy the contents of builds/leanpub into your manuscript folder which should be located in your dropbox.

Note: Don't forget to update src/Book.txt and src/Sample.txt!

More information: https://leanpub.com/help/manual#the-booktxt-file

You can also run

$ grunt wbb:publish

to execute all wbb tasks.

Self-Promotion

Like wbb? Follow the repo on Github. Any open questions? Follow Pascal Precht on Github and Twitter.

wbb's People

Contributors

0x-r4bbit avatar

Watchers

Chetan Shenoy avatar James Cloos 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.