<divclass="children"><h1>ZippyDoc</h1><divclass="text">Hi, this is the website of ZippyDoc, a compact, light-weight and human-readable format for documenting code, APIs, and other things, that can be easily converted to HTML.</div><divclass="text">It is designed primarily to be simple to use (unlike complex markup languages like reStructuredText), and very code-oriented (unlike other simple markup languages like Markdown). You will probably learn the entire syntax in about 10 minutes.</div><divclass="text">ZippyDoc (both the format and the parser) are licensed under the <ahref="http://www.wtfpl.net/">WTFPL</a>, meaning you can basically do with it whatever you want, and reuse it in any fashion you see fit. I hope it will help you write nicer, easier, and more complete documentation!</div><divclass="text">While ZippyDoc is technically intended for documentation, I decided to whip up a simple index page in ZippyDoc as well - you're looking at it! :)</div><h2>What does the ZippyDoc format look like?</h2><h7>Code:</h7><preclass="code">^ my_function(argument1, argument2)
> "ZippyDoc is awesome!"</pre><h7>Result:</h7><divclass="definition"><aname="my_functionargument1argument2">my_function(argument1, argument2) <divclass="children"><divclass="exclamation"><strong>Important:</strong> This is just an example! <divclass="children"></div></div><divclass="text">This is a function.</div><dl><dt>argument1</dt><dd>This is the first argument.<divclass="children"></div></dd></dl><dl><dt>argument2</dt><dd>This is the second argument.<divclass="children"></div></dd></dl><divclass="example">Example: How to call my_function <divclass="children"><h7>Code:</h7><preclass="code">my_function("ZippyDoc", "awesome")</pre><h7>Output:</h7><preclass="output">"ZippyDoc is awesome!"</pre></div></div></div></a></div><h2>Documentation</h2><divclass="text">The documentation for ZippyDoc can be found <ahref="documentation.html">here</a>.</div><h2>Downloading ZippyDoc</h2><divclass="text">ZippyDoc is now a PyPi package! To install it, make sure you have pip installed, and run <spanclass="fixed">pip install zippydoc</span>. You can then use the <spanclass="fixed">zpy2html</span> command anywhere, to convert your ZippyDoc source files to HTML. The GitHub repository can be found <ahref="https://github.com/joepie91/ZippyDoc">here</a>.</div></div>
