pandarose/bingus-blog
1
0
Fork 0
forked from slonk/bingus-blog
Code Pull requests Activity

document options

Browse source
This commit is contained in:
slonkazoid 2024-07-01 02:44:43 +03:00
parent 342a353b36
commit 658ddaf820
Signed by: slonk
SSH key fingerprint: SHA256:tbZfJX4IOvZ0LGWOWu5Ijo8jfMPi78TU7x1VoEeCIjM
1 changed files with 13 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -56,6 +56,7 @@ link = "https://..." # public url of the blog, required if rss is enabled
[dirs] [dirs]
posts = "posts" # where posts are stored posts = "posts" # where posts are stored
media = "media" # directory served under /media/ media = "media" # directory served under /media/
static = "static" # directory server under /static/ (css and js)
[http] [http]
host = "0.0.0.0" # ip to listen on host = "0.0.0.0" # ip to listen on
@ -126,15 +127,21 @@ every post **must** begin with a **valid** front matter. else it wont be listed
in / & /posts, and when you navigate to it, you will be met with an error page. in / & /posts, and when you navigate to it, you will be met with an error page.
the error page will tell you what the problem is. the error page will tell you what the problem is.
example: full example:
```md ```md
--- ---
title: "README" title: "My first post" # title of the post
description: "the README.md file of this project" description: "The first post on this awesome blog!" # short description of the post
author: "slonkazoid" author: "Blubber256" # author of the post
created_at: 2024-04-18T04:15:26+03:00 icon: "/media/first-post/icon.png" # icon/thumbnail of post used in embeds
#modified_at: ... # see above color: "#00aacc" # color of post, also used in embeds
created_at: 2024-04-18T04:15:26+03:00 # date of writing, this is highly
# recommended if you are on a system which doesnt have btime (like musl),
# because this is fetched from file stats by default
#modified_at: ... # see above. this is also fetched from the filesystem
tags: # tags, or keywords, used in meta and also in the ui
- lifestyle
--- ---
``` ```