From 282cd835e27e8ff21e8d8a0acf2859e96a1cdc0f Mon Sep 17 00:00:00 2001 From: JustineSmithies Date: Sat, 13 May 2023 16:20:58 +0100 Subject: Initial commit --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..2eb3a36 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# blarg + +`blarg` is a minimal blog engine based on [blog.sh](https://github.com/karlb/karl.berlin/tree/master) and [blarg](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](http://www.karl.berlin/blog.html) for more details. + +## Quickstart + +* Clone this repository `git clone https://codeberg.org/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/index-with-drafts.html` +* 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](justine@smithies.me.uk) 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. -- cgit v1.2.3