Page Template

An introductory paragraph goes here. It's not needed but can be potentially helpful to briefly explain the page's purpose and content.

Simple Paragraph

Paragraph with an external link like here with bold and italicized inline words. There can also be inline code-blocks such as this: CODE_SNIPPET

Ordered List

An ordered list can be constructed as below:

  1. List item
  2. List item
  3. List item
  4. List item
  5. List item
  6. List item

Unordered list

An unordered list can be constructed as below:

  • List item
  • List item
  • List item
  • List item
  • List item
  • List item

Single-line code block

A single-line code block is defined as below. For proper language formatting, providing the language type is necessary.

$mysql --host {hostname} --port {port number} -p --user {username}

Multi-line code block

Multi-line code blocks are defined with the same syntax as single-line code blocks.

Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 83597
Server version: 5.7.9-Vitess
Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
mysql>

Split cmd+output code blocks

Code blocks can also be configured to have a split view of a command and corresponding output by delimiting the two pieces with a ------ string. In such a case, the copy button will only copy the command and not the output.

$mysql --host {hostname} --port {port number} -p --user {username}
------
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 83597
Server version: 5.7.9-Vitess
Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
mysql>

Tables

Tables use the default markdown syntax. tablegenerator.com is a nifty little tool to visually create such tables.

Column NameColumn ManeColumn NoonColumn Moon
DataDataDataData
BassBaseBiasBlaze

Theme sensitive images

Images benefit from a brief description which also serves as the ALT tag value (will be made independently configurable later). Theme sensitive images should be added in doubles; one with a _light suffix and with _dark. The image with the _light suffix should be the one that is linked within the markdown. The system will use the dark mode image appropriately.

Organization dashboard
Organization dashboard

Theme agnostic images

Images can also be added to be theme agnostic i.e. they will not change in anyway regardless of page's theme. These images don't have a special suffix format.

Organization Settings > Members
Organization Settings > Members

Info blocks

Info blocks come in three flavors: note, warning, and tip.

This is an info callout with some more text thrown in to simulate a multi-line rendering. And an extra sentence for some density.
This is a warning callout.
This is a tip callout.
Was this page useful?
Last updated on June 15, 2021
PrivacyTerms
© 2021 PlanetScale Inc.