davnn / fastpaced

Private blog of @davnn.

Home Page:https://fastpaced.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

fastpaced

Build Status

This is a private blog proudly powered by Hakyll, the Haskell static site generator.

Articles are in their own repository to keep code and content separate; they are included via git submodule. Use

git submodule init
git submodule update --remote

to initialize and update the articles.

Travis CI is used to build this repository and to push the results to the github-pages branch. An update to the master branch of the fastpaced articles repository automatically triggers a new Travis build.

Articles are written in Markdown and Pandoc is used to transform the .md files into .html files. Each article lives in its own folder inside /articles. The folder name of an article also represents its HTML path.

All articles have metadata attached to them in form of a YAML front matter. The following metadata fields are required for all articles.

---
title: String
published: Date (YYYY-MM-DD)
author: String
---

Optional metadata is available if articles require additional features. The following fields are available:

mathematics: Boolean (true | false)
centered: Boolean  (true | false)
image: String (path)

The mathematics field enables mathematical typesetting with KaTeX. Mathematical content can then be included with $expr$ for inline content and $$expr$$ for block content.

The centered field changes the article to a centered layout instead of left-aligned.

The image field specifies the path to an image relative from the current article path. This image is used for the site meta data og:image. A default image is included if the image field is missing.

Pandoc has various possible extensions and this blog uses the fenced_divs extension to enable classes to be added to div blocks. There are classes implemented for specific content blocks like .definition, .theorem and .proof. Additionally, the width of elements can be modified with .width-small, .width-medium, .width-large and .width-full, which set the width of the element to 33%, 50% and 66% of the article. Images can optionally be shown with captions with the .caption class.

About

Private blog of @davnn.

https://fastpaced.com

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:CSS 67.0%Language:HTML 19.4%Language:Haskell 13.6%