-
Notifications
You must be signed in to change notification settings - Fork 42
Markdown utility
kodiakhq[bot] edited this page Apr 19, 2022
·
71 revisions
Utility
The Markdown utility is a light text formatting utility that will convert a
limited set of markdown to valid HTML markup. Each markdown conversion option
can be turned on or off. By default, this utility will use Carbon classes and
strips out extraneous HTML
tags.
Used by (7)
Back links (10)
Content block (2)
- optional
String
of text formatted using the Markdown utility. - See Markdown utility for more
Content group (2)
- optional
String
of text formatted using the Markdown utility. - See Markdown utility for more
- See Markdown utility for more
Content item (2)
- optional
String
of text formatted using the Markdown utility. - See Markdown utility for more
Data model (1)
copy
| Markdown utility
Universal banner (2)
- optional String of text formatted using Markdown utility with a limited
- See Markdown utility for more
String will be input into the utility, where it will search for particular string patterns and convert them to the corresponding valid HTML markup.
type | markup | description | |
---|---|---|---|
1.1 |
italic |
*italic* or _italic_
|
Renders content between a single * or _ as italic. (e.g. <em> text</em> ) |
1.2 |
bold |
**bold** or __bold__
|
Renders content between a double * or _ as bold . (e.g. <strong> text</strong> ) |
1.3 |
paragraph | \n\n |
Renders content before double new line as a paragraph (e.g. <p> ...content...</p> ) |
1.4 |
unordered list |
- list item 1 * list item 2
|
Renders one or more lines starting with - or * as an unordered list. |
1.5 |
ordered list |
1. list item 1 2. list item 2
|
Renders one or more lines starting with a number 1. or * as an ordered list. |
1.6 |
Hyperlink | [text](url) |
Renders content as an inline Carbon link |
Publishing guidelines (6)
Layout component (37)
- CTA block
- CTA section
- Callout media
- Callout quote
- Callout
- Card group
- Card section carousel
- Card section images
- Card section offset
- Card section simple
- Card section
- Content block cards
- Content block horizontal
- Content block media
- Content block mixed groups
- Content block segmented
- Content block simple
- Content block
- Content group banner
- Content group cards
- Content group pictograms
- Content group simple
- Content group
- Content item horizontal
- Content item
- Content section
- Dotcom shell
- Feature section
- Lead space block
- Lead space search
- Lead space
- Link list section
- Logo grid
- Table of contents
- Tabs extended media
- Tabs extended
- Universal banner
Service (3)
UI component (34)
- Back to top
- Background media
- Button group
- CTA
- Card in card
- Card link
- Card
- Carousel
- Expressive modal
- Feature card
- Filter group
- Filter panel
- Footer
- Image with caption
- Image
- Input select
- Leaving ibm
- Lightbox media viewer
- Link list
- Link with icon
- Locale modal
- Masthead L0
- Masthead L1
- Masthead account
- Masthead mobile
- Masthead navigation
- Masthead
- Mega menu
- Pictogram item
- Quote
- Search typeahead
- Tag group
- Tag link
- Video