path: root/README.md

# blarg

`blarg` is a minimal blog engine based on [blog.sh](https://github.com/karlb/karl.berlin/tree/master) and [barf](https://git.sr.ht/~bt/barf).

Features:

* Requires only a posix shell, a markdown processor and git
* Handle both blog posts and normal pages
* No boilerplate, just create a markdown file
* Show creation and update timestamps (taken from git history)

See the [blog post](https://justine.smithies.me.uk/blarg.html) for more details.

## Quickstart

* Clone this repository `git clone https://git.sr.ht/~justinesmithies/blarg`
* Put your blog posts as markdown files into `posts`
* Place any images into the `public` folder
* Run `./blarg` and your posts will show up in `build`
* Commit posts in git to add timestamps and have them show up in `build/index.html`
* Copy the content of `build` to your webserver, so that other people can read your blog

Feel free to contact me if you have any questions.

# Warning !

This repo also contains the content for my personal blog and homepage - https://justine.smithies.me.uk . So if you want to use `blarg` please remember to delete the contents of the posts folder and any files in the public folder too.