This page details all the page elements that can be configured with the elements rule.

Text styles

Element

Example

Element names:

  • heading1

  • heading2

  • heading3

  • heading4

  • heading5

  • heading6

rules:
  - rule: elements
    description: Do not use Heading 1 style
    level: major
    blocked:
      - heading1
YAML

Element name: quote

rules:
  - rule: elements
    description: Do not use Quotes
    level: minor
    blocked:
      - quote
YAML

Element name: paragraph

rules:
  - rule: elements
    description: Allow only paragraph styling
    level: minor
    allowed:
      - paragraph
YAML

Emoji

Element name

Example

Element name: emoji

rules:
  - rule: elements
    description: Avoid using emojis
    level: minor
    blocked: emoji
YAML

Tables

Element name

Example

Element name: table

rules:
  - rule: elements
    description: Avoid using tables
    level: minor
    blocked: table
YAML

Decision

Element

Example

Element name: decision

rules:
  - rule: elements
    description: Avoid using decision
    level: minor
    blocked: decision
YAML

Lists

Element

Example

Element names:

  • bulletList

  • numberedList

rules:
  - rule: elements
    description: Avoid using lists
    level: minor
    blocked:
      - numberedList
      - bulletList
YAML

Layouts

Element

Example

Element name: layout

Using the type and width parameters you can also specify more fine-grained which kind of layouts you want to allow/block.

Parameter type:

  • Two columns: two_equal

  • Three columns: three_equal

  • Right sidebar: two_right_sidebar

  • Left sidebar: two_left_sidebar

  • Three columns with sidebars: three_with_sidebars

Parameter width:

  • Center: default

  • Wide: wide

  • Full width: full-width

Using the type parameter:

rules:
  - rule: elements
    description: Avoid using three column layouts
    level: major
    blocked:
      - element: layout
        parameters:
          type:
            - three_equal
            - three_with_sidebars
YAML

Using the width parameter:

rules:
  - rule: elements
    description: Avoid using wide layouts
    level: major
    blocked:
      - element: layout
        parameters:
          width:
            - wide
            - full-width
YAML

Macros

Every element name in the configuration that does not match one of the above will be assumed to be a macro with that name. So this rule can be used as a drop-in replacement for the macros rule and is using the same names and parameter names.

Example:

# Avoid "Code snippet" macros

rules:
  - rule: elements
    level: major
    blocked: [code]
YAML

Missing elements for your use case?

The elements rule currently allows you to configure the most commonly used elements. If there is any specific editor element you need that is currently not supported please reach out to our support.