Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/axitkhurana/buster

Brute force static site generator for Ghost
https://github.com/axitkhurana/buster

Last synced: 3 months ago
JSON representation

Brute force static site generator for Ghost

Awesome Lists containing this project

README

        

Buster
======

Super simple, Totally awesome, Brute force **static site generator for**
`Ghost `__.

Start with a clean, no commits Github repository.

*Generate Static Pages. Preview. Deploy to Github Pages.*

Warning! This project is a hack. It's not official. But it works for me.

The interface
-------------

``setup [--gh-repo=]``

      Creates a GIT repository inside ``static/`` directory.

``generate [--domain=]``

      Generates static pages from locally running Ghost instance.

``preview``

      Preview what's generated on ``localhost:9000``.

``deploy``

      Commits and deploys changes static files to Github repository.

``add-domain ``

      Adds CNAME file with custom domain name as required by Github
Pages.

Buster assumes you have ``static/`` folder in your current directory (or
creates one during ``setup`` command). You can specify custom directory
path using ``[--dir=]`` option to any of the above commands.

Don't forget to change your blog URL in config.js in Ghost.

The Installation
----------------

Installing Buster is easy with pip:

$ pip install buster

You'll then have the wonderful ``buster`` command available.

You could also clone the source and use the ``buster.py`` file directly.

Requirements
------------

- wget: Use ``brew install wget`` to install wget on your Mac.
Available by default on most linux distributions.

- git: Use ``brew install git`` to install git on your Mac.
``sudo apt-get install git`` on ubuntu/debian

The following python packages would be installed automatically when
installed via ``pip``:

- `docopt `__: Creates beautiful
command line interfaces *easily*.
- `GitPython `__:
Python interface for GIT.

Ghost. What?
------------

`Ghost `__ is a beautifully designed,
completely customisable and completely `Open
Source `__ **Blogging Platform**. If
you haven't tried it out yet, check it out. You'll love it.

The Ghost Foundation is not-for-profit organization funding open source
software and trying to completely change the world of online publishing.
Consider `donating to Ghost `__.

Buster?
~~~~~~~

Inspired by THE GhostBusters.

.. figure:: http://upload.wikimedia.org/wikipedia/en/c/c7/Ghostbusters_cover.png
:alt: Ghost Buster Movie Poster

Ghost Buster Movie

Contributing
------------

Checkout the existing
`issues `__ or create a
new one. Pull requests welcome!

--------------

*Made with* `jugaad `__ *in*
`Dilli `__.