• February 18, 2025
• in MkDocs
• 1 min read

Blog post template

This is a template file for blog posts in MkDocs. In order to keep it simple to create new posts, the template file should have the following:

Page configuration

When creating a new blog post, determine the following page configuration options:

• the page title
• the page description (optional)
• the page icon (optional)
• the page status (optional)
• the page subtitle (optional)
• the page template (optional)

Page metadata

When creating a new blog post, determine the following page metadata:

• the post draft option
• the post date
  • can be just date: 2025-02-18
  • can also include date created and date updated
• the post authors
• the post categories
• the post slug
• the post tags

Putting it all together

Front-matter

The front-matter consists of YAML Style Meta-Data to define the page configuration settings:

---
# page configuration
title: Blog post template
description: >
  This is a template file for blog posts in MkDocs.
icon: octicons/repo-template-24
status: new
# page metadata
draft: false
date:
  created: 2025-02-18
  updated: 2025-02-18
authors:
  - rwaight
categories:
  - MkDocs
slug: blog-post-template
tags:
  - MkDocs
  - Template
---

Example section

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.