Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

70 lines (70 sloc) 4.699 kB
<!DOCTYPE html>
<html>
<head>
<meta content="text/html;charset=UTF-8" http-equiv="Content-type" />
<title>parslet -Documentation</title>
<meta content="Kaspar Schiess (http://absurd.li)" name="author" />
<link href="images/favicon3.ico" rel="shortcut icon" /><link href="/parslet/stylesheets/site.css" media="screen" rel="stylesheet" type="text/css" /><link href="/parslet/stylesheets/sh_whitengrey.css" media="screen" rel="stylesheet" type="text/css" /><script src="/parslet/javascripts/sh_main.min.js" type="text/javascript"></script><script src="/parslet/javascripts/sh_ruby.min.js" type="text/javascript"></script></head>
<body class="code" onload="sh_highlightDocument();">
<div id="everything">
<div class="main_menu"><img alt="Parslet Logo" src="/parslet/images/parsley_logo.png" /><ul>
<li><a href="index.html">about</a></li>
<li><a href="get-started.html">get started</a></li>
<li><a href="install.html">install</a></li>
<li><a href="documentation.html">documentation</a></li>
<li><a href="contribute.html">contribute</a></li>
</ul>
</div>
<div class="content">
<h1>Documentation</h1><p><a href="get-started.html"><strong>Getting Started</strong></a></p>
<p>Are you brand new to parslet? Well then let&#8217;s introduce you guys. This is what
you should read and try out first.</p>
<p><a href="https://github.com/kschiess/parslet/tree/master/example/"><strong>Examples</strong></a></p>
<p>Parslet comes with a lot of examples that explain how to use various aspects.
Take a look at those.</p>
<p><a href="overview.html"><strong>In depth</strong></a></p>
<p>This is the real technical documentation, showing you how to use all aspects
of parslet. Especially:</p>
<ul>
<li><a href="overview.html">Overview</a> explains parslet&#8217;s goals and gives you a bigger
picture.</li>
<li>Using <a href="parser.html">Parslet::Parser</a> to <strong>write parsers</strong>.</li>
<li>Using <a href="transform.html">Parslet::Transform</a> to <strong>transmogrify your intermediary
trees</strong>.</li>
<li><a href="tricks.html">Tricks</a> for common situations.</li>
</ul>
<p><strong>Presentations</strong></p>
<ul>
<li><a href="https://docs.google.com/present/view?id=0AfXgUAUtzyc7ZGZrcG1mNXNfMzIwZ3JjY2c3NW0">Parslet, An Introduction</a> introduces parslet in a few poignant slides. (Bo Jeanes and David Pick)</li>
</ul>
<p><strong>Blogs</strong></p>
<ul>
<li><a href="http://florianhanke.com/blog/2011/02/01/parslet-intro.html">Parslet Intro</a>
explains quite a few things on how parsers work and on parser
metaprogramming. Besides, Florian Hanke also explains how to create an <span class="caps">ERB</span>
parser in just a few lines!</li>
</ul>
<ul>
<li><a href="http://jmettraux.wordpress.com/2011/05/11/parslet-and-json/">Parslet and
<span class="caps">JSON</span></a> shows how
to construct a <span class="caps">JSON</span> parser in a few lines.
<a href="http://jmettraux.wordpress.com/about/">John</a> does a great job of explaining
how parslet ties back in with railroad diagrams.</li>
</ul>
<p><a href="http://rubydoc.info/gems/parslet/frames"><strong><span class="caps">YARD</span> Class Documentation</strong></a></p>
<p>The <a href="http://rubydoc.info/gems/parslet/frames"><span class="caps">YARD</span> documentation</a> will help you
with the nitty gritty. This documentation is real important too. It will be
constantly improved! (Thanks linode.com and DockYard for sponsoring this tool.)</p></div>
<div class="copyright"><p><span class="caps">MIT</span> License, 2010-2012, &#169; <a href="http://absurd.li">Kaspar Schiess</a><br/>
Logo by <a href="http://floere.github.com">Florian Hanke</a>, <a href="http://creativecommons.org/licenses/by/1.0/">CC Attribution</a> license</p></div>
<script type="text/javascript">var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-16365074-2']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();</script>
</div>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.