Go to file
Niko Abeler 3c6df116fa use template for post list 2022-08-18 21:09:02 +02:00
.vscode refactoring 2022-07-20 19:32:32 +02:00
assets removed reference 2022-08-15 21:37:04 +02:00
cmd simple test for rss feed 2022-08-16 20:36:05 +02:00
embed use template for post list 2022-08-18 21:09:02 +02:00
.gitignore .gitignore + README 2022-08-03 16:49:17 +02:00
Dockerfile Release as docker image 2022-08-16 21:06:13 +02:00
README.md mascot in README 2022-08-15 21:06:17 +02:00
directories.go limit posts to single depth directory 2022-08-03 18:03:10 +02:00
embed.go refactoring rendering 2022-08-18 21:06:06 +02:00
go.mod renaming to owl-blogs 2022-08-03 16:55:48 +02:00
go.sum http router 2022-08-01 21:06:48 +02:00
kiss_test.go renaming to owl-blogs 2022-08-03 16:55:48 +02:00
post.go Include Date in RSS Feed #3 + Parse metadata as struct 2022-08-13 19:07:10 +02:00
post_test.go items in rss feed. #3 2022-08-13 18:47:56 +02:00
release.sh Release as docker image 2022-08-16 21:06:13 +02:00
renderer.go use template for post list 2022-08-18 21:09:02 +02:00
renderer_test.go renaming to owl-blogs 2022-08-03 16:55:48 +02:00
repository.go refactoring rendering 2022-08-18 21:06:06 +02:00
repository_test.go Collect aliases 2022-08-06 19:38:13 +02:00
rss.go sorting posts by date. Resolves #4 2022-08-17 21:57:55 +02:00
rss_test.go items in rss feed. #3 2022-08-13 18:47:56 +02:00
user.go improved list performance (1000 posts -> 118ms). #5 2022-08-17 22:21:44 +02:00
user_test.go improved list performance (1000 posts -> 118ms). #5 2022-08-17 22:21:44 +02:00

README.md

Mascot

Owl Blogs

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

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
date: 13 Aug 2022 17:07 UTC
aliases:
     - /my/new/post
     - /old_blog_path/
---

Actual post