Skip to content

Writing Blog Posts

Publishing blog posts in the Documentation Hub is straight forward.

Preparation

  1. Follow the Setup steps to connect your repository
  2. Create a new documentation page and add the blog type to your pages frontmatter (see below)

Features

The blog is created from a markdown page in your repository. All markdown features supported by GitHub should work out of the box. Some additional features are added by the Documentation Hub.

Frontmatter

In addition to GitHub Markdown, the Documentation Hub does allow some Frontmatter metadata. Frontmatter is an embedded YAML document at the top of the Markdown file enclosed in --- dashes at the start and end of the YAML document.

The following frontmatter properties are required for a blog post:

  • type - The type has to be set to blog
  • date - This should be the date of publishing and is formatted like this yyyy-mm-dd
  • title - The title of the blog post.
  • author - Could be a GitHub username or a plain name (e.g. firstname lastname). GitHub usernames will lead to an extended display of that user, based on the GitHub profile
  • tags - A YAML list of text entries. It is used to allow filtering the blog. Add topic keywords to your page. Please add at most 3 tags to not overflow the blog filters.

  • teaser - This property defines the text and presentation for the blog homepage. It displays a short introduction of your post in the overview.

    The teaser consists of title, roof-title and description sub-properties. It's a YAML object.

    The title and description could be simple markdown in it's own. Please be careful what you put here. It's not meant to embed full documents, but just a teasing description of your documentation or project.

Example Frontmatter

---
type: blog
date: 2000-01-01
title: "The year 2k has started"
tags:
  - "y2k-bug"
teaser:
  title: "Start the new decade with a non-bug"
  roof-title: "The y2k bug"
  description: "This blog post is about the year 2000 bug"
---

# Headline

Paragraph
Last updated: January 26, 2026 at 18:12
By: renovate-token-app[bot]