Project

newstile

0.0
No commit activity in last 3 years
No release in over 3 years
newstile is parser for the newstile dialect of markdown. Newstile is optimised for typing on mobile devices like iPhone and Andorid mobiles. It is forked from Thomas Leitner's kramdown, which is a fast, pure Ruby, markdown parser.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies
 Project Readme
# newstile

newstile is newstile-parser. It is forked off Thomas Leitner's markdown parser kramdown, and
modified to support the newstile syntax. Newstile is a markdown dialect optimized for fast typing
on mobile devices like iPhone and Android phones.

The syntax definition can be found in doc/syntax.page, a quick reference in doc/quickref.page. All
the documentation is available online at http://newstile.rubyforge.org.


# Usage

newstile has a basic *Cloth API, so using newstile is as easy as

    require 'newstile'

    Newstile::Document.new(text).to_html


# Development

Just clone the git repository as described in doc/installation.page you are good to go. You probably
want to install `rake` so that you can use the provided rake tasks. Aside from that:

* The `tidy` binary needs to be installed for the automatically derived tests to work.
* The `latex` binary needs to be installed for the latex-compilation tests to work.


# License

See the COPYING file.