Fork me on GitHub

JQtextile is a textile interpreter plug-in for the jQuery javaScript framework.

Dependencies

jQuery 1.6.x.

Demonstration

Here you can see an example of JQtextile in action (including some aspects that don't work yet). The input here is taken from the contents of an element, but could just as easily be a string of text extracted from a JSON object.

Plain text input:


h1. Level One Heading

Some +inserted (underlined) text+, *strong (bold) text*, _emphasized (italic) text_, -deleted (struck through) text-, %{color:red}colorful text%, %{font-size:18pt}bigger text%, super-script ^text^, sub-script ~text~. 

bq. A piece of block quoted text, including a reference to a footnote[1]

Quotes to 'curley quotes', text with a ??citation??, text with some @code@, text with an elipsis..., text with an em--dash, text with an en-dash, text with a 2 x 2 dimension, text with Trademarks(TM), and(R) copyright symbols(C), text surrounded by a %span%.

These don't work yet: *_bold italic text_*, *-bold struck through text-*, *_-bold italic struck through text-_*, *+bolder underlined text+*, _+italic underlined text+_, *_+bold italic underlined text+_*, *_+-bold italic underlined struck through text-+_*.

fn1. This is a footnote.

h2. Level two heading

* "A link to another page":http://notreadbyhumans.github.com/JQtextile/ diam vitae mi aliquet non cursus risus posuere;
* Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos;
* Donec bibendum fermentum dolor.
** Donec bibendum fermentum dolor.
** Donec bibendum fermentum dolor.
*** Donec bibendum fermentum dolor.
*** Donec bibendum fermentum dolor.

Quisque fermentum, urna sit amet posuere interdum, tellus mauris tincidunt odio, vitae lacinia orci diam tempor dolor.

# "Aliased URL One":JQtextile
# "Aliased URL Two":JQtextile
# "Aliased URL Three":JQtextile
## Three point one
## Three point two
### Three point two point one
### Three point two point two

[JQtextile]http://notreadbyhumans.github.com/JQtextile/

h3. Level three heading

!http://notreadbyhumans.github.com/JQtextile/images/octocat.png!

h4. Level four heading

Etiam massa sapien, pharetra id tempus ac, congue in purus. Donec egestas lacinia ligula, elementum dapibus massa pellentesque eu. Nunc mauris neque, egestas blandit faucibus eu, malesuada ut ipsum. Nulla fringilla condimentum libero. Cras suscipit, enim eu semper aliquam, sem velit ultrices lorem, nec interdum massa est eget sem. Vestibulum fringilla iaculis laoreet. Mauris sem libero, tristique eget commodo sed, laoreet sit amet velit. Vestibulum sollicitudin, libero sit amet laoreet luctus, est augue posuere diam, ac blandit magna felis nec eros. 

|_. Header |_. Header |_. Header |
| Cell 1 | Cell 2 | Cell 3 |
| Cell 1 | Cell 2 | Cell 3 |

Executing the JQtextile conversion - Textile in, HTML out:

$('#textile_destination').JQtextile('textile', textile_string);

Output:

Download

You can download this project in either zip or tar formats.

You can also clone the project with Git by running:

$ git clone git://github.com/notreadbyhumans/JQtextile

Authors

Much of JQtextile is based upon JavaScript Textile by Ben Daglish.

jQuery port and maintenance by http://twitter.com/notreadbyhumans

Copyright and license

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.