Blog format
Properties
The key: value block at the top of a file, and every property each file accepts.
A file may start with a block of properties between two lines of ---, one key: value per line:
---
title: Reading slowly
published_date: 2026-10-02 09:30
tags: books, habits
---
One page a day is still a book a year.
Keys are lower case. A file that does not start with --- has no properties. An unknown key, or a value in the wrong form, is refused with its line number.
Articles (posts/) and pages (pages/)#
| Property | Value |
|---|---|
title | Required. Up to 300 characters. |
published_date | 2026-10-02 or 2026-10-02 09:30, in the blog's time zone. A future date schedules it. |
tags | Comma-separated, at most 20, each up to 60 characters. |
publish | false keeps it offline. |
alias | Old addresses, comma-separated paths such as /old-name, at most 10. |
canonical_url | Where the original lives, if it was first published elsewhere. |
meta_description | The summary for search and sharing. Without it, the first paragraph is used. |
meta_image | The image for sharing. Without it, a card is generated. |
lang | A language code such as en or zh-CN, when it differs from the blog's. |
class_name | Extra class names for the page's <body>, for styling one article. |
make_discoverable | false keeps it off the front page. |
Articles also take:
| Property | Value |
|---|---|
post_header, post_footer, post_aside | false hides that part on this article. |
pinned | true pins it on the blog's fediverse profile. |
true and false are written exactly so.
home.md#
| Property | Value |
|---|---|
title | Required. The blog's name, up to 200 characters. |
seo_title | A different title for search results. |
meta_description | The blog's summary for search, sharing and feeds. |
meta_image | The image for sharing. |
favicon | The icon's address. |
Site parts#
| File | Properties |
|---|---|
footer.md | enabled, powered_by (false hides the Bearletter credit; Pro) |
post-header.md, post-footer.md, post-aside.md | enabled |
nav.md, social.md, blogroll.md, directories.md, redirects.md and styles.css have no properties.
Markdown#
Bodies are CommonMark with GitHub tables, strikethrough and footnotes. HTML is allowed and cleaned; on Free, <style> elements and style attributes are removed, on Pro they are kept.
Bearletter · bearletter.com · Every page is also Markdown: llms.txt