Skip to content

markdown

A rich text.

Where it sits

Body In the body Inside its texts
The store’s home Yes Yes
A custom page Yes Yes
A product’s page Yes Yes
An event’s page Yes Yes
A portfolio’s page Yes Yes
A lesson Yes Yes
An article Yes Yes

A text holds it as a <block type="markdown" props="…"></block> element: its props are those below but type, which the element’s own type names.

See Bodies for how a body holds its blocks.

Props

Name Type Required Description
id string Yes The block’s id, unique within its body.
type "markdown" Yes The block’s type.
title string No Kept, but not shown.
subtitle string No Kept, but not shown.
content string Yes A rich text.
allowMultipleColumns boolean No Whether a long text may flow in columns on wide screens.
hidden boolean No Whether the block is hidden: it, and every block it holds, doesn’t show.

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The block's id, unique within its body."
    },
    "type": {
      "type": "string",
      "const": "markdown",
      "description": "The block's type."
    },
    "title": {
      "type": "string",
      "description": "Kept, but not shown."
    },
    "subtitle": {
      "type": "string",
      "description": "Kept, but not shown."
    },
    "content": {
      "type": "string",
      "description": "A rich text."
    },
    "allowMultipleColumns": {
      "type": "boolean",
      "description": "Whether a long text may flow in columns on wide screens."
    },
    "hidden": {
      "type": "boolean",
      "description": "Whether the block is hidden: it, and every block it holds, doesn't show."
    }
  },
  "required": [
    "id",
    "type",
    "content"
  ],
  "description": "A rich text.",
  "additionalProperties": false
}

Type to search…

↑↓ navigate↵ selectEsc close