jklepatch / goblog

A simple blog with Markdown / metadata support, written in Go

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Goblog

Simple Markdown blog in Go

Getting started

(pre-requisite: go v1.11 or above)

Install the dependencies:

make install

Start the server:

make start

Visit http://localhost:8080 to access your blog in your browser. To modify the url, modify the URL string in index.go

Writing blog posts

Content

  • Blog posts are written as files in the markdown folder
  • Files are written in markdown, ith the md file extension
  • Files match url path. Ex: /about.md will serve markdown/about.md

Special files:

  • index.md is the root page of your blog
  • 404.md is used when the requested url matches no blog post

Metadata

Metadata is required for each page you add to your blog. You specify above the content, wrapped by ---:

---
title: my Title
description: my SEO title
template: filename of the template to use, without file extension
---

Adding templates

Go Templates can be added in the templates directory, with the extenstion gohtml

In templates, you can use:

{{.Title}}
{{.Description}}
{{.Body}}

About

A simple blog with Markdown / metadata support, written in Go


Languages

Language:Go 92.3%Language:Makefile 7.7%