Skip to content

Latest commit

 

History

History
64 lines (39 loc) · 1.82 KB

README.md

File metadata and controls

64 lines (39 loc) · 1.82 KB

NoraMark_HTMLBook

Dependency Status

HTMLBook generator plugin for NoraMark

Installation

Add this line to your application's Gemfile:

gem 'nora_mark_htmlbook'

And then execute:

$ bundle

Or install it yourself as:

$ gem install nora_mark_htmlbook

Usage

From command line

$ nora2htmlbook < text.nora > result.html

Explicitly load your code

require 'nora_mark'
require 'nora_mark_htmlbook'

NoraMark::Extensions.register_generator(NoraMark::Htmlbook::Generator)
puts NoraMark::Document.parse(markup_text).htmlbook

Specify in frontmatter in the markup text

---
title: document title
generator: htmlbook
---

# Chapter 1

Lorem ipsum dolor sit amet, consectetuer adipiscing elit.  

## Section 1

Donec hendrerit tempor tellus. Donec pretium posuere tellus. Proin quam nisl, tincidunt et, mattis eget, convallis nec, purus. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nulla posuere. Donec vitae dolor. Nullam tristique diam non turpis. Cras placerat accumsan nulla. Nullam rutrum. Nam vestibulum accumsan nisl.

Contributing

  1. Fork it ( http://github.com//nora_mark_htmlbook/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request