GithubHelp home page GithubHelp logo

goblog's Introduction

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}}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.