stayingcozy

Markdown style guide

A quick tour of everything a post can contain, so you can see how each piece looks. Delete this file whenever you like.

Text#

Regular paragraphs, bold, italic, strikethrough, inline code, and links. External links open in a new tab.

Blockquotes get an accent bar on the left. Good for quoting someone or calling something out.

Lists#

  • Unordered lists
  • With a few items
    • And nesting
  1. Ordered lists
  2. Work too
  • Task lists
  • From GitHub-flavored markdown

Code#

Fenced blocks are highlighted when you name the language:

type Post = { slug: string; title: string; date: string };

export function newest(posts: Post[]): Post | undefined {
  return [...posts].sort((a, b) => b.date.localeCompare(a.date))[0];
}
fn main() {
    let greeting = "hello";
    println!("{greeting}, world"); // prints: hello, world
}
npm run dev

Images#

Put images in public/images/ and reference them from the root. Add a title in quotes and it becomes a caption:

Placeholder avatar
This caption comes from the image title.

Tables#

FeatureSupported
Tablesyes
Footnotesyes1
Raw HTMLyes

Headings#

Third-level headings#

These show up indented in the table of contents. Fourth-level and below are left out of it to keep it short.

Footnotes#

  1. Footnotes land at the bottom of the post. ↩