https://github.com/jklepatch/goblog
A simple blog with Markdown / metadata support, written in Go
https://github.com/jklepatch/goblog
Last synced: 8 months ago
JSON representation
A simple blog with Markdown / metadata support, written in Go
- Host: GitHub
- URL: https://github.com/jklepatch/goblog
- Owner: jklepatch
- Created: 2019-11-03T07:56:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-03T07:57:23.000Z (over 6 years ago)
- Last Synced: 2025-02-10T09:07:43.236Z (about 1 year ago)
- Language: Go
- Size: 1.95 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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}}
```