chrono
/
blop
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

readme

This commit is contained in:
Drew 2019-09-26 08:06:04 +01:00
parent aee148c8f1
commit 2b6f94ae02
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -38,6 +38,15 @@ This file should contain the url of your blog's root, without a trailing slash.
**There are examples for all of these files over at the [example blog](https://gitlab.com/uoou/blop_blog)**.
The blog's title (which is derrived from the filename of the markdown) and author (which defaults to the value at the top of the blop script) can, either or both, be overridden on a per-post basis by putting information at the top of the markdown file in the following form (including dashes):
```
---
author: Someone
title: Some Title
----
```
The rest you can do with as you like. Put whatever static html you want in the root and link to it from other pages, add an images folder, lots of CSS, videos, under-construction animated gifs...
Each time blop is run it will delete all the html files in the `posts` directory (so don't put any other static content in there, make a separate directory or put it in the root), the `index.html` file and `rss.xml`. It won't touch anything else.