This is a multi-author, open source blog for tutorials across different kind of tech, with an API that let's you run code!
How it works:
- The website itself it built with Jekyll and hosted with Github Pages.
- The backend that runs code is Go & Docker. Source code and API documentation is coming soon.
How to write articles.
The article name should be in the following format:
This is not really enforced, it just makes it easier to grep for an author's articles, because unfortunately Jekyll does not traverse subdirectories to look for posts! :(
Now let's look at the frontmatter of the posts (taken from here):
layout: post title: "Lists" slug: "lists" date: 2013-04-06 categories: ["@crufter", haskell-tutorial] seriesid: cht13 articleindex: 6 redirect_from: - /2013/04/06/haskell-tutorial-lists/
Notable things here:
The first category is the author, prepended with a
@, this is mandatory.
The second category is optional.
seriesid & articleindex
seriesid is used for grouping articles into a series of article. It helps navigation, for example, when you read an article which has other articles in the same series, you will see a list of other articles in the same series in the sidebar, have previous and next buttons, etc.
articleindex is used for ordering the post within a series.
0 articleindex will appear as the sole representator of the article series (for example showing up on the main page).
By default, using the standard Jekyll and Rouge highlight, you get, well.. standard Jekyll and Rouge highlights in your blog post.