-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,40 @@ | |
A plain and simple blog engine in Go. It serves Markdown files from a folder | ||
as HTML with a little bit of styling to make it all bearable and nice. | ||
|
||
## Setup | ||
|
||
To get started, you'll need a config like this: | ||
|
||
host: http://localhost:8080 | ||
posts_path: ../posts | ||
emails_path: emails.txt | ||
|
||
meta: | ||
title: My Awesome Blog | ||
author: Me, the Author | ||
email: [email protected] | ||
links: | ||
Git: https://github.com/me-the-author | ||
YouTube: https://www.youtube.com/channel/me-the-author | ||
|
||
smtp: | ||
host: smtp.mail.com | ||
port: 587 | ||
username: [email protected] | ||
password: p4ssw0rd | ||
sender: [email protected] | ||
|
||
You don't have to set up an SMTP server if you don't want; it'll still work | ||
without it, you'll just see some errors in the server logs. | ||
|
||
## Usage | ||
|
||
To launch your blog, use the CLI: | ||
|
||
glean -conf prod.yml -port 80 | ||
|
||
As long as your setup is good, it'll get going and you're in business! | ||
|
||
## Features | ||
|
||
- [x] On-the-fly Markdown -> HTML conversion for posts | ||
|