prose/README.md
Naman Sood c1452146e2 readme: only sass in PATH works
Signed-off-by: Naman Sood <mail@nsood.in>
2023-07-30 01:13:22 -04:00

788 B

Prose

Prose is a blogging platform written in Go, which I am building to serve my own blog.

Setup

As of July 2023, libsass is no longer available, so the environment running this binary must have access to sass on the PATH.

Usage

Blog posts should be created in the format title-slug.md. Work in progress posts should be stored as WIP-title-slug.md. Static content should be stored in the static/ folder, appropriately arranged.

Posts will be served as /title-slug, and files like static/random/file/structure.txt will be served as /random/file/structure.txt. When title slugs and static files conflict, slugs will have higher precdence. An RSS feed of the blog is available at /rss.xml.

To start the server:

go run .

Server will be live on port 8080.