Skip to content

A middleman project template for an HTML ebook or a documentation site that needs runnable examples.

License

Notifications You must be signed in to change notification settings

k2052/middleman-ebook

Repository files navigation

Middleman-ebook

A middleman project template for an HTML ebook or a documentation site that needs runnable examples. Has runnable code examples, live tests using using mocha + chai, and a generated Table of Contents.

Screenshot

Installation

Via clone

$ git clone git@github.com:k2052/middleman-ebook.git my-project

Or

Template Install

All middleman projects can be easily installed as a template for reuse

$ git clone git@github.com:k2052/middleman-ebook.git ~/.middleman/ebook

The to use it you just do:

$ middleman init -T=ebook my-project

Usage

Put a table of contents in data/toc.yml. Other than that, just have a look around. I'll improve the documentation here shortly!

Copyright and licence

Copyright 2013 K-2052, under the MIT licence.

Credits

The theme for this is heavily inspired by Docco's linear theme Runnable code accomplished using a modification of executr List, Menu and Doc-text icons from Entypo

About

A middleman project template for an HTML ebook or a documentation site that needs runnable examples.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published