gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
static-cms/website/content/docs/widgets/markdown.md

22 lines
1.1 KiB
Markdown
Raw Normal View History

New design for the widgets section in the docs (#866) * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Rebased and updated the info according to @verythorough contribution * Fixing the yaml codes for the relation and select widget sections * Merging with widgets.md and app.j * Fixing some silly mistakes (sorry!) * Following @verythorough contributions :) * Adding the markdown widget and fixing the widgets container background * Adding the URL functionality and myself as a contributor :) * Adding myself as a contributor :)
2018-01-03 20:14:15 -02:00
---
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
label: "Markdown"
convert website from hugo to gatsby (#1369)
2018-07-25 07:47:26 -04:00
target: markdown
New design for the widgets section in the docs (#866) * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Rebased and updated the info according to @verythorough contribution * Fixing the yaml codes for the relation and select widget sections * Merging with widgets.md and app.j * Fixing some silly mistakes (sorry!) * Following @verythorough contributions :) * Adding the markdown widget and fixing the widgets container background * Adding the URL functionality and myself as a contributor :) * Adding myself as a contributor :)
2018-01-03 20:14:15 -02:00
---
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.
(docs) fixed 404s and minor typos (#1639) **Summary** Fixed 404s (converted absolute links to relative links) and minor typos across several pages. **Test plan** Previewed locally **A picture of a cute animal (not mandatory but encouraged)** ![pups](https://user-images.githubusercontent.com/31967674/44364132-353b6480-a494-11e8-9b01-ff7d32bfceda.jpg)
2018-08-20 16:37:10 -04:00
*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.
New design for the widgets section in the docs (#866) * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Rebased and updated the info according to @verythorough contribution * Fixing the yaml codes for the relation and select widget sections * Merging with widgets.md and app.j * Fixing some silly mistakes (sorry!) * Following @verythorough contributions :) * Adding the markdown widget and fixing the widgets container background * Adding the URL functionality and myself as a contributor :) * Adding myself as a contributor :)
2018-01-03 20:14:15 -02:00
- **Name:** `markdown`
- **UI:** full text editor
- **Data type:** markdown
- **Options:**
- `default`: accepts markdown content
Update markdown widget documentation
2018-04-14 12:57:12 +02:00
- `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`.
New design for the widgets section in the docs (#866) * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Rebased and updated the info according to @verythorough contribution * Fixing the yaml codes for the relation and select widget sections * Merging with widgets.md and app.j * Fixing some silly mistakes (sorry!) * Following @verythorough contributions :) * Adding the markdown widget and fixing the widgets container background * Adding the URL functionality and myself as a contributor :) * Adding myself as a contributor :)
2018-01-03 20:14:15 -02:00
- **Example:**
docs(fix): widget example code layout on Site (#1606) * Fix widget example layout * Stop running MarkDown through Prettier.
2018-08-14 07:37:07 -07:00
```yaml
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
- {label: "Blog post content", name: "body", widget: "markdown"}
docs(fix): widget example code layout on Site (#1606) * Fix widget example layout * Stop running MarkDown through Prettier.
2018-08-14 07:37:07 -07:00
```
This would render as:
![Markdown widget example](/img/widgets-markdown.png)
Reference in New Issue Copy Permalink