simple blog generator
This repository has been archived on 2023-09-18. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Christoph 93525aa350 update reqs 2014-08-25 01:31:14 +02:00
blogtopoid fix not in check 2014-07-24 16:51:54 +02:00
doc don't use md for (tag) listing pages. 2014-02-09 17:19:56 +01:00
.gitignore .gitignore 2014-02-07 00:00:00 +01:00
.travis.yml use coveralls 2014-02-24 19:16:10 +01:00
LICENSE initial import 2014-02-07 00:00:00 +01:00
README.rst add deps badge 2014-07-24 15:17:38 +02:00
post-receive.example initial import 2014-02-07 00:00:00 +01:00
requirements.txt update reqs 2014-08-25 01:31:14 +02:00
setup.cfg initial import 2014-02-07 00:00:00 +01:00
setup.py don't use md for (tag) listing pages. 2014-02-09 17:19:56 +01:00
tox.ini add flake8 dep 2014-02-07 15:42:09 +01:00

README.rst

|PyPI version| |Build Status| |Dependency Status|

blogtopoid
==========

This is pre-alpha. Most things don't work yet.

blogtopoid is a blog generator - it takes a bunch of posts, renders them
to HTML and saves them to a web directory.

Structure
=========

Work flow:

-  take all documents from pagesdir, render them and save them to outputdir/.
-  take all posts from inputdir, render and save to outputdir/YYYY/mm/dd/. 
   post filename must be "YYYYMMDD post title.ext".
-  generate index.html linking all posts.
-  generate rss feed including all posts.
-  generate listing pages for all used tags.
-  pack and copy style files from style/ to outputdir/style/.

Post formats
============

Currently posts and pages can either be markdown2 or reStructuredText.

In posts and pages ``{{blogurl}}`` gets replaced with blogurl from
config, in style files ``{{styleurl}}`` with blogurl/style.

Usage
=====

-  pip install --pre blogtopoid
-  run blogtopoid --quickstart
-  run blogtopoid
-  see post-receive.example for automatically deploying from git
   commits.

TODO
====

-  implement --post
-  TEST!
-  make a shipable default template
-  paginate index (not relevant with current index)
-  check hashes

.. |PyPI version| image:: https://badge.fury.io/py/blogtopoid.png
   :target: https://pypi.python.org/pypi/blogtopoid
.. |Build Status| image:: https://travis-ci.org/hansenerd/blogtopoid.png?branch=master
   :target: https://travis-ci.org/hansenerd/blogtopoid
.. |Dependency Status| image:: https://gemnasium.com/hansenerd/blogtopoid.svg
   :target: https://gemnasium.com/hansenerd/blogtopoid