Caleb ebc2471c6b
docs(fix): revert prettier formatting on markdown files (#1612)
Prettier formatting our markdown files is causing bugs because of the
differences between Gatsby's parser and Prettier's. Also, Prettier
formats the inline code-blocks containing example CMS configs, but the
formatting it uses doesn't really make much sense or match the suggested
CMS config style.

It doesn't actually make much sense to format the docs anyway, since we
use the CMS itself to edit/generate them.
2018-08-14 11:33:13 -06:00

1.1 KiB

label target
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: in case you want to use your markdown editor to fill a markdown's file content after the frontmatter, you'll have name the field as body so then the CMS can recognize it and save 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