28 lines
1.1 KiB
Markdown
Raw Normal View History

---
label: "Markdown"
target: "markdown"
---
### Markdown
The markdown widget provides a full fledged text editor - which is based on [slate](https://github.com/ianstormtaylor/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
2018-04-13 19:50:01 +02:00
- `buttons`: a list of string representing the buttons to display ('bold', 'italic', 'code', 'link', 'heading-one', 'heading-two', 'quote', 'code-block', 'bulleted-list', 'numbered-list'). If this options is missing, all the buttons are display.
- **Example:**
```yaml
- {label: "Blog post content", name: "body", widget: "markdown"}
```
This would render as:
![Markdown widget example](/img/widgets-markdown.png)