Skip to content
Branch: master
Go to file
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Rant

http://github.com/lrvick/rant

TravisCI Test Coverage Code Climate PyPI version Wheel Dependencies License

About

"Rant" is a CLI driven blog-aware website generator written in python. It is intended to make maintaining a blog or personal website easy as modifying text files in your favorite editor.

Insipired by great projects such as: Jekyll, Pelican, Goldbarg, and piles of others

Current Features

  • Simple post/page authoring as markdown text files
  • sitemap.xml support
  • RSS / Atom support
  • Full jinja2 templating integration
  • Pagination
  • Pygments syntax hilighting
  • Disqus commenting integration in default templates
  • Other stuff

Usage / Installation

  1. Install rant

    Stable:

    pip install --user rant

    Development:

    pip install --user --upgrade -e git+https://github.com/lrvick/rant/#egg=rant
  2. Start a new rant project

    Create a folder where you intend your site to live and initialize rant.

    rant install my_rant_blog

    This will populate the folder with the basic rant project ready to add posts to.

  3. Create a post or page

    To create a page or blog post do:

    rant create

    This will open your default $EDITOR with a template like the following:

    ---
    layout: post
    title:
    date: 2011-09-23 02:45
    image:
    tags:
    comments: true
    draft: false
    ---

    Fill out the top YAML block as you desire, then add your post below the '---' in Markdown format.

    On saving it will automatically generate any needed html for the page according to the 'post' templates found in 'layouts/post.html' .

    To edit a post in the future simply edit it and regenerate.

    vim posts/201109230245-My_neat_blog_post.md
    rant build

    From here you can also modify any of the media found in /static, or edit any of the Jinja2 layouts found in 'layouts' to your liking.

    Happy ranting :-)

  4. Preview your work

    A development web server is included that will run rant build for you whenever you make changes to your source directory, then reload your browser.

    Start it with:

    rant serve

    The server will be reachable at http://localhost:8080 by default.

Notes

Use at your own risk. You may be eaten by a grue.

Questions/Comments?

You can find me on the web via:

Email | Blog | Twitter | Facebook | Google+ | YouTube | Last.fm | LinkedIn | Github

About

CLI driven, blog aware static site generator in Python

Resources

License

You can’t perform that action at this time.