some more docs in README
This commit is contained in:
parent
fb05e0de49
commit
3bf4ec4c94
21
README.md
21
README.md
|
@ -2,7 +2,6 @@
|
|||
|
||||
A simple web server for blogs generated from Markdown files
|
||||
|
||||
|
||||
## Repository
|
||||
|
||||
A repository holds all data for a web server. It contains multiple users.
|
||||
|
@ -34,3 +33,23 @@ Each directory in the `/users/` directory of a repository is considered a user.
|
|||
\- config.yml
|
||||
-- Contains settings global to the user.
|
||||
-- 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
|
||||
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue