1.3 KiB

label title
Markdown markdown

The markdown widget provides a full fledged text editor - which is based on slate - that allows users to format text with features such as headings and blockquotes. Users are also allowed to write in markdown by simply flipping a switch.

Please note: If you want to use your markdown editor to fill a markdown file contents after its frontmatter, you'll have to name the field body so the CMS recognizes it and saves the file accordingly.

  • Name: markdown

  • UI: full text editor

  • Data type: markdown

  • Options:

    • default: accepts markdown content
    • buttons: an array of strings representing the formatting buttons to display, all buttons shown by default. Buttons include: bold, italic, code, link, heading-one, heading-two, quote, code-block, bulleted-list, and numbered-list.
  • Example:

    - { label: 'Blog post content', name: 'body', widget: 'markdown' }
    

This would render as:

Markdown widget example

Please note: The markdown widget outputs a raw markdown string. Your static site generator may or may not render the markdown to HTML automatically. Consult with your static site generator's documentation for more information about rendering markdown.