Skip to content
/ Giki Public

Live, asynchronous parser for a almost any markup language (wiki text, BB code etc....)

License

Notifications You must be signed in to change notification settings

20after4/Giki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Documentation

See it in action:

http://guyht.github.com/Giki/

Welcome to GIKI

GIKI is a simple, real time, asynchronous parsing framework that suppors a wide variety of parsers. Currently, BBCode and wiki text are supported, and it is very easy to customize and create new parsers.

The performance of the parsers is outstanding as they make use of webworkers via the https://github.com/guyht/GWorker library.

Installation

Simply add the following to your HEAD tag:

<script src="giki.js" type="text/javascript"></script>

If you would like the script to be compatible with older browsers that do not support web workers, then also download and add the https://github.com/guyht/GWorker script to yoru HEAD tag. This is recommended.

<script src="gworker.js" type="text/javascript"></script>

NOTE: The gworker script must be included before the giki script

Usage

Add a text area to your page to receive input, and a div to receive the parsed data and make sure they have unique ids.

<div id="giki_div"></div>
<textarea id="giki_ta"></textarea>

Then simply invoke the giki object

new Giki({
 'div' : 'giki_div',
 'text_area' : 'giki_ta',
 'parser' : 'bbcode.js'
});

Et voila!

Adding new parsers

Giki is designed with extensibility in mind. Writing new parsers is very simple. New parsers are written as web workers (they will also work in older browsers thanks to https://github.com/guyht/GWorker) and therefore only need to implement the onmessage function, and use the postMessage function to return the parsed data.

self.onmessage = function(event) {
 var data = event.data;
 // ......
 // Do some parsing
 // .......
 self.postMessage(data);
};

About

Live, asynchronous parser for a almost any markup language (wiki text, BB code etc....)

Resources

License

Stars

Watchers

Forks

Packages

No packages published