directory structure

This commit is contained in:
Niko Abeler 2022-08-03 17:56:13 +02:00
parent e657b69f50
commit 3b67e7731d
1 changed files with 34 additions and 1 deletions

View File

@ -1,3 +1,36 @@
# Owl Blogs # Owl Blogs
A simple web server for blogs generated from Markdown files 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.
Each directory in the `/users/` directory of a repository is considered a user.
### User Directory structure
```
<user-name>/
\- public/
\- <post-name>
\- 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
\- media/
-- Contains all media files used in the blog post.
-- All files in this folder will be publicly available
\- meta/
\- base.html
-- The template used to render all sites
\- VERSION
-- Contains the version string.
-- Used to determine compatibility in the future
\- config.yml
-- Contains settings global to the user.
-- For example: page title and style options