Skip to content
This repository

sh-written blog engine generating static HTML pages

branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README
shblog
======

shblog by AddiKT1ve <the.addikt1ve@gmail.com>
shblog is distributed under the terms of the GPL v3.

INSTALLATION
------------

### Any way

$ git clone git://github.com/addikt1ve/shblog.git
$ cd shblog
# ./install.sh

You can optionally use a prefix with install.sh, such as:

$ ./install.sh $HOME/shlog

### Arch Linux way

Arch users may want to install shblog-git from the AUR:
<http://aur.archlinux.org/packages.php?ID=38360>

### shblog + httpd

Call shblog gen to generate HTML files; thus you just have to create a symlink:

$ ln -s $STATICDIR /var/www/shblog

Assuming that your DocumentRoot is /var/www/, your blog should be available at
http://localhost/shblog/

CONFIGURATION
-------------

In order to run shblog, its configuration has to be copied to $HOME/.config.
Make sure that $HOME/.config directory already exists!

$ cp -r /etc/shblog $HOME/.config/

Basically, all you need to edit is in $CONFDIR/shblog.conf.
If you wish to use the upload function, please edit $CONFDIR/upload.conf.
Enabled modules are listed in $CONFDIR/modules.conf.

BASIC USAGE
-----------

You will mainly use the "post" command:

$ shblog post [post-title]

This command creates a new .shpost file in $DATADIR/year/month/day/.
Once you're finished with editing your new post, shblog will automatically do
the generation job. But if you edit your .shpost file later, you will need to
launch the HTML generation process by yourself:

$ shblog gen single <post-id>

And if you need to update your blog's index:

$ shblog gen index

I know it **can** be improved. So please:
http://github.com/addikt1ve/shblog/issues

Enjoy using shblog :-)
Something went wrong with that request. Please try again.