Skip to content

Commit

Permalink
Auto-update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
kschiess committed May 25, 2012
0 parents commit d204fdb
Show file tree
Hide file tree
Showing 18 changed files with 1,615 additions and 0 deletions.
109 changes: 109 additions & 0 deletions contribute.html
@@ -0,0 +1,109 @@
<!DOCTYPE html>
<html>
<head>
<meta content="text/html;charset=UTF-8" http-equiv="Content-type" />
<title>parslet -Contribute</title>
<meta content="Kaspar Schiess (http://absurd.li)" name="author" />
<link href="images/favicon3.ico" rel="shortcut icon" /><link href="/cod/stylesheets/site.css" media="screen" rel="stylesheet" type="text/css" /><link href="/cod/stylesheets/sh_whitengrey.css" media="screen" rel="stylesheet" type="text/css" /><script src="/cod/javascripts/sh_main.min.js" type="text/javascript"></script><script src="/cod/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="/cod/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>Contribute</h1><p>Find parslet to be really useful? Or just found a bug that is really ruining
the day for you? Please contribute! Find the code on
<a href="http://github.com/kschiess/parslet">github</a>.</p>
<h2>Contact</h2>
<p>Join us on <span class="caps">IRC</span> in #parslet.</p>
<p>Discussion and patches (or the odd cry for &#8216;Help! How can I parse X?&#8217;) should
go to our mailing list at
<a href="mailto:ruby.parslet@librelist.com">ruby.parslet@librelist.com</a>. Just write a
short message to that address and <a href="http://librelist.com">librelist</a> will
subscribe you. <span class="caps">NNTP</span>/web interface can be had through
<a href="http://dir.gmane.org/gmane.comp.lang.ruby.parslet">gmane.org</a>:
<code>gmane.comp.lang.ruby.parslet</code>.</p>
<h2>Bugs</h2>
<p>Log in to github and open a bug ticket
<a href="https://github.com/kschiess/parslet/issues">here</a>. Please be sure to include
the version of parslet and Ruby; maybe you can even provide some code that
exhibits the bug?</p>
<p>And of course if you provide a properly tested patch, you&#8217;ll be our hero and
get a place in the space below for lifetime.</p>
<h2>Projects</h2>
<p>Have you got a project that uses parslet? Please write
<a href="mailto:kaspar.schiess@absurd.li">us</a> about it.</p>
<p><a href="https://github.com/matthewd/capuchin"><strong>Capuchin</strong></a></p>
<p>A javascript compiler that targets the rubinius VM. (Matthew Draper)</p>
<p><a href="https://github.com/kschiess/parslet/tree/master/example/"><strong>Examples</strong></a></p>
<p>In here, you can find a parser for a lisp like language and much more.</p>
<p><a href="https://github.com/postmodern/net-http-server"><strong>Net::<span class="caps">HTTP</span>::Server</strong></a></p>
<p>A really small and elegant <span class="caps">HTTP</span> server written in Ruby. Think Webrick. Using
parslet. (Postmodern)</p>
<p><a href="https://github.com/undees/thnad"><strong>thnad</strong></a></p>
<p>Thnad is a tiny programming language with so few features that it is not useful for anything at all &#8212; except showing how to write a compiler in half an hour.</p>
<p><a href="https://github.com/kschiess/wt"><strong>wt</strong> aka working title</a></p>
<p>A small parser that compiles to a postscript file. This is mostly for demoing
the various aspects of a parser.</p>
<p><a href="https://github.com/rk/werd"><strong>Werd.rb</strong></a></p>
<p>A variant of Chris Pound&#8217;s word generator written in Ruby, with some
improvements. (Robert Kosek)</p>
<p><a href="https://github.com/meh/versionub"><strong>versionub</strong></a></p>
<p>A semantic version parser. (meh)</p>
<h2>Thanks for all the fish &#8212; Contributions</h2>
<ul>
<li><strong>rogerbraun</strong> (<a href="https://github.com/rogerbraun">rogerbraun</a>) for being my
unicode tester.</li>
</ul>
<ul>
<li><strong>meh</strong> (<a href="http://meh.paranoid.pk/">meh</a>) for taking a real close look.</li>
</ul>
<ul>
<li><strong>John Mettraux</strong> (<a href="http://jmettraux.wordpress.com/">jmettraux</a>) for the really
nice <span class="caps">JSON</span> example and for pushing parslet beyond its limits.</li>
</ul>
<ul>
<li><strong>Josep M. Bach</strong> (<a href="http://www.txustice.me/">txus</a>) for minding the small
things that make a big difference.</li>
</ul>
<ul>
<li><strong>Matthew Draper</strong> (<a href="http://matthewd.net/">matthewd</a>) for bothering with my
broken <span class="caps">CSS</span>.</li>
</ul>
<ul>
<li><strong>Hal Brodigan</strong> (<a href="http://postmodern.github.com/">postmodern</a>) for solving our
email parsing needs!</li>
</ul>
<ul>
<li><strong>R. Konstantin Haase</strong> (<a href="http://rkh.im/">rhk</a>) for rspec matchers that help
stamp out, eliminate and abolish redundancy.</li>
</ul>
<ul>
<li><strong>Florian Hanke</strong> (<a href="http://floere.github.com">floere</a>) has given a lot of very
inspiring input for parslet. His questions have been key to rounding off the
corners and making the library as aesthetic as it is. And just look at the
logo.</li>
</ul>
<ul>
<li><strong>Kaspar Schiess</strong> (<a href="http://www.absurd.li">absurd.li</a>) for being brave enough
to actually add another parser library to a field that&#8217;s already bursting
at the seams.</li>
</ul></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>
70 changes: 70 additions & 0 deletions documentation.html
@@ -0,0 +1,70 @@
<!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="/cod/stylesheets/site.css" media="screen" rel="stylesheet" type="text/css" /><link href="/cod/stylesheets/sh_whitengrey.css" media="screen" rel="stylesheet" type="text/css" /><script src="/cod/javascripts/sh_main.min.js" type="text/javascript"></script><script src="/cod/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="/cod/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>

0 comments on commit d204fdb

Please sign in to comment.