Add a markdown section to the design system
From discussion !1537 (comment 212549482):
GitLab uses "GitLab Flavored Markdown" (GFM). It extends the CommonMark specification (which is based on standard Markdown) in several ways to add additional useful functionality. It was inspired by GitHub Flavored Markdown.
You can use GFM in the following areas:
- Comments
- Issues
- Merge requests
- Milestones
- Snippets (the snippet must be named with a
.md
extension) - Wiki pages
- Markdown documents inside repositories
- Epics (ULTIMATE)
You can also use other rich text files in GitLab. You might have to install a dependency to do so. Please see the gitlab-markup
gem project for more information.
Elements that can be rendered using GFM:
- Tables
- Code block
- Diagrams
- Blockquotes
- Lists
- etc..
Proposal
Add a GitLab Markdown section to Pajamas to capture markdown elements, their design guidelines, and usage within the design system.