h4kor/owl-blogs
h4kor
/
owl-blogs
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

some more docs in README

This commit is contained in:
Niko Abeler 2022-08-08 22:17:03 +02:00
parent fb05e0de49
commit 3bf4ec4c94
1 changed files with 23 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -2,14 +2,13 @@
A simple web server for blogs generated from Markdown files A simple web server for blogs generated from Markdown files
## Repository ## Repository
A repository holds all data for a web server. It contains multiple users. A repository holds all data for a web server. It contains multiple users.
## User ## User
A user has a collection of posts. A user has a collection of posts.
Each directory in the `/users/` directory of a repository is considered a user. Each directory in the `/users/` directory of a repository is considered a user.
### User Directory structure ### User Directory structure
@ -18,7 +17,7 @@ Each directory in the `/users/` directory of a repository is considered a user.
<user-name>/ <user-name>/
\- public/ \- public/
\- <post-name> \- <post-name>
\- index.md \- index.md
-- This will be rendered as the blog post. -- This will be rendered as the blog post.
-- Must be present for the blog post to be valid. -- Must be present for the blog post to be valid.
-- All other folders will be ignored -- All other folders will be ignored
@ -33,4 +32,24 @@ Each directory in the `/users/` directory of a repository is considered a user.
-- Used to determine compatibility in the future -- Used to determine compatibility in the future
\- config.yml \- config.yml
-- Contains settings global to the user. -- Contains settings global to the user.
-- For example: page title and style options -- For example: page title and style options
```
### Post
Posts are Markdown files with a mandatory metadata head.
- The `title` will be added to the web page and does not have to be reapeated in the body. It will be used in any lists of posts.
- `aliases` are optional. They are used as permanent redirects to the actual blog page.
```
---
title: My new Post
aliases:
- /my/new/post
- /old_blog_path/
---
Actual post
```