Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Static Blogging Engine inspired by Octopress and Pelican

Project description

What is it?
-----------

Stabe is ___Sta___tic ___B___logging ___E___ngine writen in Python inspired from
Octopress and Pelican. Designed to make it painless to author and update large blogs.
Some key features are:

- Lighweight
- Cross platform
- Standalone content directory.
- Easy-to-author configuration.
- Use your favorite editor for everything.
- Easy installation, easy to use, extendable and customize

Here's a sample of [publishing using Stabe](http://blog.arissh.com/).


More Features
-------------

- Static output
- Use any editor
- One-step to add a new post and page
- Uses existing DSLs: Markdown (content) + YAML (metadata) + Mustache (template)
- Simple logic-less templates
- Mobile device layout support
- Ability to work offline
- Logical placement of assets (content-related ones near the content, layout ones in the template)
- Incremental building and fast builds.
- Auto generated RSS Feed
- Live preview with a local server
- Content directory format is decoupled from output.
- Deploy to general hosting (via RSync and FTP) and or cloud hosting (PaaS like GAE, Github, Heroku, AppFog, etc)


Installation
------------

1. Clone the repository via `git clone git@github.com:riespandi/stabe.git`
2. Run `cd stabe` to get to your newly cloned repository.
2. Install all required dependencies by running `pip install -r requirements.txt`.
3. Run `./stabe` to build and `./stabe preview` to run a webserver.
4. Open <http://localhost:4000> in your browser.
5. That's all, enjoy it!


Usage
-----

Build incrementally.

> ./stabe build

Forcibly rebuild everything regardless of whether or not there have been
changes made to the content. This is useful if you change your template.

> ./stabe rebuild

Start watching for local changes to the content, rebuilding
incrementally based on that.

> ./stabe watch

Start a really simple local web server with its document root pointing
to the output directory.

> ./stabe preview

Deploy the site to the specified server (gae, ftp, rsync, git). Default
deploy server defined at `stabe.yaml`.

> ./stabe deploy <server>


Directory structure
-------------------

- `/articles/` contains your articles written in Markdown.
- `/include/` contains files for included when generating output.
- `/output/` contains files generated by Stabe.
- `/plugins/` contains Stabe plugins script.
- `/themes/` contains files written in HTML and Mustache templates.
- `/site.yaml` is the configuration file about your site.
- `/stabe.yaml` is the Stabe configuration file.


License
-------

Stabe is released under the terms of the MIT License and is free to use and modify.
It's free to redistribute as long as you abide by the distribution terms of the license.

Copyright (c) 2013 Aris S Ripandi, aris [at] arissh.com

Read MIT License here: <http://opensource.org/licenses/MIT>



Authors
-------

Aris S Ripandi "riespandi"


Contributors
------------

- Sebastian Wagner "sebix"
- 0x1cedd1ce
- Moritz Schlarb "moschlar"
- Mark van Lent "markvl"
- the_metalgamer
- Thomas Weißschuh "t-8ch"
- Alexander Zhirov "nevkontakte"
- Christoph Polcin "chripo"
- Daniel Pritchard "dpritchard"

Project details


Release history Release notifications

This version
History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
stabe-0.1.0.win32.exe (364.5 kB) Copy SHA256 hash SHA256 Windows Installer any Aug 21, 2013
stabe-0.1.0.zip (133.3 kB) Copy SHA256 hash SHA256 Source None Aug 21, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page