static-cms/website/content/docs/widget-markdown.mdx

38 lines
1.4 KiB
Plaintext
Raw Normal View History

2022-09-30 11:39:35 -04:00
---
group: Widgets
title: Markdown
weight: 19
2022-09-30 11:39:35 -04:00
---
2022-11-02 15:42:21 -04:00
## Overview
2022-09-30 11:39:35 -04:00
2022-11-02 15:42:21 -04:00
- **Name:** `markdown`
- **UI:** [Toast UI Editor](https://ui.toast.com/tui-editor)
- **Data type:** `markdown string`
2022-09-30 11:39:35 -04:00
2022-11-02 15:42:21 -04:00
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.
2022-09-30 11:39:35 -04:00
2022-11-02 15:42:21 -04:00
_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
```
2022-09-30 11:39:35 -04:00
This would render as:
2022-10-26 09:23:11 -04:00
![Markdown widget example](/img/widgets-markdown.webp)
2022-09-30 11:39:35 -04:00
2022-11-02 15:42:21 -04:00
_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.