38 lines
1.4 KiB
Plaintext
38 lines
1.4 KiB
Plaintext
---
|
|
group: Widgets
|
|
title: Markdown
|
|
weight: 19
|
|
---
|
|
|
|
## Overview
|
|
|
|
- **Name:** `markdown`
|
|
- **UI:** [Toast UI Editor](https://ui.toast.com/tui-editor)
|
|
- **Data type:** `markdown string`
|
|
|
|
The markdown widget provides a full fledged text editor allowing users to format text with features such as headings and blockquotes. Users can change their editing view with a handy toggle button.
|
|
|
|
_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.
|
|
|
|
## Widget options
|
|
|
|
For common options, see [Common widget options](/docs/widgets#common-widget-options).
|
|
|
|
| Name | Type | Default | Description |
|
|
| ------- | ------ | ------- | --------------------------------------------------------------------- |
|
|
| default | string | `''` | _Optional_. The default value for the field. Accepts markdown content |
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
name: body
|
|
label: Blog post content
|
|
widget: markdown
|
|
```
|
|
|
|
This would render as:
|
|
|
|
|
|
|
|
_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.
|