Attention:
Version 0.3.0 requires grunt ~0.4.0
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 Leanpub, so even publishing your books works like a charm.
Follow Web Books on Twitter
- Grunt to automate all the things!
- Pandoc-based doc generation
- Supports most used formats: mobi, epub, HTML
- Compatible with Leanpub
- Markdown-based
- SASS support
@tspike adapted Scott Chacon's Pro Git! Check the demo here: http://tspike.github.com/wbb-demo/ and the source https://github.com/tspike/wbb-demo
Checkout the full documentation right here!
Dependencies:
Clone the repository via git and install the npm dependencies
$ git clone https://github.com/WebBooks/wbb new-book
$ cd new-book
$ npm install
Ready to start! Write your book by creating chapter files in src/chapters
.
Since v0.2.0
you can specify your chapters folder wherever you want. All you
have to do, is to specify your chapter files in src/Book.txt
. Note that the
order of generated chapters depends on the for of file names in Book.txt.
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 versionwbb:epub
- epub versionwbb:mobi
- mobi versionwbb:rtf
- rtf version
If you want to publish your book on leanpub.com, wbb is your friend. It provides a task to prepare your book for the 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 book folder.
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.
Like wbb? Follow the repo on Github. Any open questions? Follow Pascal Precht on Github and Twitter.