docs: add markdown parsing clarification (#1598)
This commit is contained in:
parent
c6ae1e8fc0
commit
c592b293ba
@ -5,7 +5,7 @@ title: 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 that the CMS can recognize it and save the file accordingly.
|
||||
_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
|
||||
@ -14,8 +14,13 @@ The markdown widget provides a full fledged text editor - which is based on [sla
|
||||
- `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:**
|
||||
|
||||
```yaml
|
||||
- {label: "Blog post content", name: "body", widget: "markdown"}
|
||||
- { label: 'Blog post content', name: 'body', widget: 'markdown' }
|
||||
```
|
||||
This would render as:
|
||||
![Markdown widget example](/img/widgets-markdown.png)
|
||||
|
||||
This would render as:
|
||||
|
||||
![Markdown widget example](/img/widgets-markdown.png)
|
||||
|
||||
_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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user