Skip to content

Markdown features

This site is intended to support GitHub flavored markdown.

In more detail, this means that CommonMark syntax is supported, plus a few additional features, like tables and Mermaid diagrams. Some of these features are detailed below.

Images

Markdown images are supported. Relative paths should be used to reference images.

Smaller images are rendered at their native pixel width. Larger images will be scaled down to fit the width of the content area. Image aspect ratios should always be preserved.

Example logo image

Code Blocks

Code blocks with syntax highlighting are supported. A full list of supported languages can be found in the Pygments documentation. An example using the hcl language is rendered below.

terraform {
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 4.16"
    }
  }

  required_version = ">= 1.2.0"
}

provider "aws" {
  region  = "us-west-2"
}

resource "aws_instance" "app_server" {
  ami           = "ami-830c94e3"
  instance_type = "t2.micro"

  tags = {
    Name = "ExampleAppServerInstance"
  }
}

Mermaid diagrams

This site supports Mermaid diagrams in the same way as GitHub. Mermaid diagrams are authored in code blocks with the language metastring set to mermaid, and those code blocks are rendered as diagrams.

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

Tables

Tables can be written in GitHub flavored markdown format. For more information, see the GitHub Flavored Markdown documentation on Tables.

Table Header Row
Cell content More cell content Another table cell

Note that autolinks are not supported. For example, https://example.com will not be rendered as a link, as it might be in other GitHub flavored markdown contexts.

Instead, you can write either: