add a nice README file
This commit is contained in:
parent
20bc3040e2
commit
3c567cab94
|
@ -0,0 +1,50 @@
|
|||
zero-blog
|
||||
=========
|
||||
|
||||
This is the small blog engine to render and serve the blog zero-knowledge.org.
|
||||
Templates can be changed in `templates` and new posts can be created in `files/content/post`.
|
||||
|
||||
build
|
||||
-----
|
||||
|
||||
To build this project a simple
|
||||
|
||||
```
|
||||
go build
|
||||
```
|
||||
|
||||
will suffice. It will automatically pack all files into the binary.
|
||||
|
||||
run
|
||||
---
|
||||
|
||||
To run the project after building, call
|
||||
|
||||
```
|
||||
./zero-blog --help
|
||||
```
|
||||
|
||||
to get a list of all parameters.
|
||||
|
||||
To dump the content into `tmp`, use `zero-blog --dump-files=tmp`. Or use
|
||||
`zero-blog` to start a local webserver.
|
||||
|
||||
add new content
|
||||
---------------
|
||||
|
||||
To add new content, place a new markdown file in `files/content`.
|
||||
|
||||
Add a Header to the file in the following format:
|
||||
|
||||
```
|
||||
+++
|
||||
title = "new title"
|
||||
time = "2021-01-02T15:16:17"
|
||||
author = "Gibheer"
|
||||
published = true
|
||||
template = "default.html"
|
||||
+++
|
||||
```
|
||||
|
||||
Template is using `default.html` by default. If you need to use a different one, then
|
||||
set that variable.
|
Loading…
Reference in New Issue