bloggenator

command module
v0.0.0-...-0e48e74 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 12, 2020 License: Apache-2.0 Imports: 1 Imported by: 0

README

Go Report Card

blog-generator

A static blog generator that collects posts written in Markdown from the local file system (OR a configurable GitHub repository). A post has metadata in a YAML file header. The code that this is forked from has this is an example repo for the blog at https://zupzup.org/.

Features

  • Listing
  • Sitemap Generator
  • RSS Feed
  • Code Highlighting
  • Archive
  • Configurable Static Pages
  • Tags
  • File-Based Configuration

Installation

go get github.com/fbaube/bloggenator

Usage & Customization

Configuration

The tool can be configured using a config file called bloggen.yml. There is a bloggen.yml.FS in the repository you can use as a template.

Example Config File: (OBSOLETE - FORMAT HAS CHANGED!)

generator:
    repo: 'https://github.com/zupzup/blog'
    tmp: 'tmp'
    dest: 'www'
blog:
    url: 'https://www.zupzup.org'
    language: 'en-us'
    description: 'A blog about Go, JavaScript, Open Source and Programming in General'
    dateformat: '02.01.2006'
    title: 'zupzup'
    author: 'Mario Zupan'
    frontpageposts: 10
    statics:
        files:
            - src: 'static/favicon.ico'
              dest: 'favicon.ico'
            - src: 'static/robots.txt'
              dest: 'robots.txt'
            - src: 'static/about.png'
              dest: 'about.png'
        templates:
            - src: 'static/about.html'
              dest: 'about'
Running

Just execute

bloggenator
Templates

Edit templates in static folder to your needs.

Example Blog Repository

(OLD) Blog

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL