Blog post template
- Template
This post shows the formatting a HyperAI blog post can use. When the frontmatter has no description, the opening paragraphs become the summary in the post list and in link previews.
Headings and text
Sections start with ## and subsections with ###. The title comes from the frontmatter, so a post has no # heading of its own.
Text can be bold, italic or code. Links can go to a page on this site, like the getting started guide, or to another site, like HyperAI on GitHub.
Lists
- Bulleted items start with
- - Keep each item short
- Numbered steps start with
1. - Markdown counts them up for you
Images
The text in the square brackets describes the image for screen readers, and shows if the image doesn't load.
Callouts
A note with a title
Notes add context. The title in square brackets is optional.
Tips work the same way.
Warnings are for things readers must not miss.
Quotes, code and tables
A quote, such as a line from a customer or a partner.
python train.py --epochs 10| Frontmatter | What it does |
|---|---|
title | Post title, required |
date | Publish date as YYYY-MM-DD, required |
description | Summary in the post list and link previews |
authors, tags | Shown under the title |
image | Link preview image, 1200 by 630 pixels |