Using Markdown

Using markdown (zfm), demonstrating components, styles, etc.

Zach Sherman

Published on 2/15/2021
internalmarkdown

Table of Contents

You can automatically generate a table of contents by adding toc: true to the frontmatter of any blog post. Headings will be automatically hyperlinked to the appropriate element and deault to using the header text as a value.This can be customized by appending {#custom-id} to the end of the text. This id will be slugified and used as both in the table of contents as well as the id value for the href in the link.

Variables

Here is a link using a variable defined in the file.

Tables

FeatureSafetyPerformance
Progressive type safety
Fail safety
Memory safety
Ergonomic safety
Vector/Rust native
Stateless

Syntax Highlighting

1error[E103]: unhandled fallible assignment
2 ┌─ :1:5
3
41 │ . = parse_common_log(.log)
5 │ --- ^^^^^^^^^^^^^^^^^^^^^^
6 │ │ │
7 │ │ this expression is fallible
8 │ │ update the expression to be infallible
9 │ or change this to an infallible assignment:
10 │ ., err = parse_common_log(.log)
11
12 = see documentation about error handling at https://errors.vrl.dev/#handling
13 = learn more about error code 103 at https://errors.vrl.dev/103
14 = see language documentation at https://vrl.dev
1[prop]
2 test = true
3 thing = false
function test() {
if (thing) {
return true;
if (false) {
return true;
}
}
}

Tabs

What happens?

What happens?

Block Quotes

Good timber does not grow with ease: The stronger wind, the stronger trees; The further sky, the greater length; The more the storm, the more the strength.

Jumps

Jump components give you a stylish way to link to other documents by using a customer directive like so:

article
Document
Transformation

Admonitions

descriptionnote

This is used to provide some helpful info to the user about the current doc but should be a litle less attention grabbing.

infotip

Welcome to the thunderdome! This is used to provide some helpful info to the user about the current doc.

check_circlesuccess

This can be used to show an example of something in the document while specifically calling attention to it.

warningwarning

This is a warning message, and can be used to warn a user about something they might need to look out for.

errorcaution

This is a very important caution message, and can be used to show that something is very important to pay attention to.

boltdanger

This is a very important caution message, and can be used to show that something has gone wrong or is critical to pay attention to.

format_list_numberedexample

This can be used to show an example of something in the document while specifically calling attention to it.