bade

bade

.. image:: https://raw.githubusercontent.com/bmcorser/bade/master/docs/source/_static/bade.png :alt: bade :width: 300px

Micro-blogging with rST

.. image:: https://badges.gitter.im/Join%20Chat.svg :alt: Gitter :target: https://gitter.im/bmcorser/bade?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

Bade is a small command line utility to allow the user to maintain a simple HTML website and weblog using only plaintext rST for their content. It also bundles some rST directives and roles (see the docs_) for:

- rendering DOT graphs to SVG
- rendering LaTeX to SVG

It's very similar in spirit to some other things. It's like Pelican_ but it's a lot simpler and uses Mako_ instead of Jinja2_. It's also like Tinkerer_ but without the dependency on Sphinx_. It also lets you use DOT and LaTeX.

Bade is opinionated and simplistic, I wrote it mostly my own usage, so you probably shouldn't use it.

.. _the docs: http://pythonhosted.org/bade/ .. _Pelican: http://docs.getpelican.com/ .. _Mako: http://www.makotemplates.org/ .. _Jinja2: http://jinja.pocoo.org/docs/ .. _Tinkerer: http://tinkerer.me/ .. _Sphinx: http://sphinx-doc.org/

Plans to extend

In writing Bade, I came up with a few things more I'd like to do:

- **Test suite**: Everything should be tested, right?
- **Git integration**: For dirty checking on build, maybe stamping a
  rendered file with its latest commit hash. There are `a few`_ GitHub
  `issues`_ for it.
- **Hooks**: Let people hook in at interesting points, ie. call ``grunt``
  pre-build, commit after build, etc.

.. _a few: https://github.com/bmcorser/bade/issues/5 .. _issues: https://github.com/bmcorser/bade/issues/4

Documentation

It's here_, there's a tutorial_.

.. _here: http://pythonhosted.org/bade/ .. _tutorial: http://pythonhosted.org/bade/tutorial.html