TrackMaven / TrackMaven.github.io

TrackMaven's Engine Room Blog
http://engineroom.trackmaven.com
0 stars 1 forks source link

Engine Room

The TrackMaven development blog powered by Pelican

Development.

Build the builder docker container

docker-compose build builder

Then run the builder docker container

docker-compose up

Navigate to localhost:8080/localdocker:8080

Setting up article

We have modified the standard preamble to better serve our theme. Below is an example of what preamble is required for our articles.

Title: <YOUR TITLE>
Date: <PUBLISH DATE>
Category: <CATEGORY>
Tags: <TAGS SEPERATED BY COMMAS>
Slug: <URL SLUG>
Author: <AUTHOR>
Avatar: <AVATAR (AUTHOR SLUG)>

Please note that the common practice has been to create tags in lowercase and the Avatar: is the Author's name "slugified" (i.e. Maven the Corgi becomes maven-the-corgi).

Publishing

Once a new article is ready, simply run the command fab push to publish the article to GitHub.