Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
119 lines (116 sloc) 5.94 KB
---
layout: default
title: Obraz - static blog-aware site generator in Python mostly compatible with Jekyll
heading:
<section id="obraz-logo">
<h1>Obraz</h1>
</section>
---
<section>
<section id="obraz-definition">
<p><strong>Obraz</strong> (<em>Russian: Образ</em>). IPA: /ˈobrəs/ <em>n.</em></p>
<ol>
<li>Image, the result of applying a function to an argument</li>
<li>A static blog-aware site generator in Python mostly compatible with Jekyll</li>
</ol>
</section>
</section>
{% include 'buttons.html' %}
<!-- GitHub corner -->
<a href="https://github.com/vlasovskikh/obraz" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
<section class="twocolumn-left">
<div class="break"></div>
<section id="why-obraz">
<h2>Why?</h2>
<p>There are many static site generators. Why choose Obraz?</p>
<dl>
<div class="reason">
<dt>Python</dt>
<dd>Written in <a href="http://xkcd.com/353/">Python</a></dd>
</div>
<div class="reason">
<dt>&lt; 800</dt>
<dd>Single source file less than <a href="https://github.com/vlasovskikh/obraz/blob/master/obraz.py">800</a> lines of code</dd>
</div>
<div class="reason">
<dt>Jekyll</dt>
<dd>Mostly <a href="{{ site.baseurl }}/jekyll.html">compatible</a> with a popular Jekyll</dd>
</div>
<div class="clear"></div>
</dl>
</section>
<div class="break"></div>
<section id="news" class="hfeed">
<h2>News <a href="{{ site.baseurl }}/feed.atom"><img src="{{ site.baseurl }}/media/feed.png" alt="(feed)"/></a></h2>
{% for post in site.posts | batch(5) | first %}
<section class="hentry">
<div class="published">{{ post.date.strftime('%Y-%m-%d') }}</div>
<h3><a href="{{ site.baseurl }}{{ post.url }}">{{ post.title }}</a></h3>
{% if loop.index == 1 %}
{{ post.content }}
{% endif %}
</section>
{% endfor %}
<p><a href="{{ site.baseurl }}/archive.html">Archive...</a></p>
</section>
<div class="break"></div>
<section>
<h2>Plugins</h2>
<p>Plugins allow extending the site generation process via user-defined processing functions.</p>
<p>Featured plugins:</p>
<ul>
<li><a href="https://github.com/vlasovskikh/obraz/blob/master/doc/_plugins/tags.py">Tags</a>: Generate per-tag pages</li>
</ul>
<p>See other available plugins in the <a href="{{ site.baseurl }}/plugins.html">plugins documentation</a>.</p>
</section>
<div class="break"></div>
<section>
<h2>Development</h2>
<p>The <a href="https://github.com/vlasovskikh/obraz">source code</a> is available on GitHub:</p>
<pre><code>$ git clone https://github.com/vlasovskikh/obraz.git
</code></pre>
<p>Bug reports, feature requests, and contributions are welcome!</p>
</section>
</section>
<section class="twocolumn-right">
<div class="break"></div>
<section id="quickstart">
<h2>Quickstart</h2>
<p>Let's create a statically generated blog!</p>
<ol>
<li>
<p>Install Obraz from the <a href="http://pypi.python.org/pypi/obraz/">Python package index:</a></p>
<pre><code>$ pip install obraz
</code></pre>
</li>
<li>
<p>Create a new blog in the <code>my-blog</code> directory:</p>
<pre><code>$ obraz new my-blog
</code></pre>
</li>
<li>
<p>Generate your site using Obraz:</p>
<pre><code>$ cd my-blog
$ obraz serve</code></pre>
<p>and check the results in the browser by visiting <a href="http://localhost:8000/">http://localhost:8000/</a>.</p>
<p>You've got your first Obraz blog up and running! Now it's time to play with the design and customize things.</p>
</li>
</ol>
</section>
<div class="break"></div>
<section>
<h2>Documentation</h2>
<p>Obraz is mostly compatible with Jekyll 1.4. Since most parts of the <a href="http://jekyllrb.com/docs/home/">Jekyll documentation</a> are valid for Obraz too, Obraz doesn't have its own documentation.</p>
<p>However, there are several <a href="{{ site.baseurl }}/jekyll.html">differences from Jekyll</a> you should be aware of.</p>
<p>See also the source code of <a href="{{ site.baseurl }}/users.html">sites that use Obraz</a> for examples of using RSS feeds, Markdown pages, tags, custom URLs, etc.</p>
</section>
<div class="break"></div>
<section id="videos">
<h2>Videos</h2>
<ul>
<li>
<p><a href="http://www.youtube.com/watch?v=DTm4bHPZ7Vc&t=17m32s">Lightning talk</a> (5 min) at PyCon RU 2013 (Russian)</p>
</li>
</ul>
</section>
</section>