From 3bf4ec4c9419ac65896ef95b29b0ce7fe7fb614b Mon Sep 17 00:00:00 2001 From: Niko Abeler Date: Mon, 8 Aug 2022 22:17:03 +0200 Subject: [PATCH] some more docs in README --- README.md | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 208468d..f5ef6ca 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,13 @@ A simple web server for blogs generated from Markdown files - ## Repository A repository holds all data for a web server. It contains multiple users. ## 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. ### User Directory structure @@ -18,7 +17,7 @@ Each directory in the `/users/` directory of a repository is considered a user. / \- public/ \- - \- index.md + \- index.md -- This will be rendered as the blog post. -- Must be present for the blog post to be valid. -- 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 \- config.yml -- Contains settings global to the user. - -- For example: page title and style options \ No newline at end of file + -- 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 + +```