#List
Retype includes broad support for creating lists of items, including unordered, ordered, and description lists.
#Unordered lists
Unordered list variations include:
#Bullet
- Item 1
- Item 2
- Item 3
#Task list
- Item 1
- Item 2
- Item 3
#Icon list
By applying the following {.list-icon}
generic attribute, you can convert a bullet list into an icon list.
Without the {.list-icon}
css class applied, the above sample would render as:
- Item 1
- This is sub-item 1.1
- This is sub-item 1.2
- This is sub-item 1.3
- Item 2
- This is sub-item 2.1
- This is sub-item 2.2
- This is sub-item 2.3
- This is sub-item 2.4
#Ordered lists
Ordered list variations include:
1.
for numbers (default)a.
for lowercase lettersA.
for uppercase lettersi.
for lowercase Roman numeralsI.
for uppercase Roman numerals
#Numbers
- Item 1
- Item 2
- Item 3
#Lowercase letters
- Item 1
- Item 2
- Item 3
#Uppercase letters
- Item 1
- Item 2
- Item 3
Uppercase letter ordered lists are not broadly supported across all web browsers, so the above sample might render as a lowercase letter list for you. Hopefully, support within the web browsers will improve over time.
#Lowercase Roman numerals
- Item 1
- Item 2
- Item 3
#Uppercase Roman numerals
- Item 1
- Item 2
- Item 3
Uppercase Roman numeral ordered lists are not broadly supported across all web browsers, so the above sample might render as a lowercase Roman numeral list for you. Hopefully, support within the web browsers will improve over time.
#Description List
A Description List (<dl>
) is a way to display Terms (<dt>
) along with their corresponding Details (<dd>
).
The Description List is commonly used to create a glossary or dictionary where you have a word and its meaning listed together.
#Basic list
- Term 1
- Detail 1
- Term 2
- Detail 2
- Term 3
- Detail 3
#Include nested components
- Term 1
Detail 1 With a paragraph
This is a block quote
- Nested item 1
- Nested item 2
- Term 2
Detail 2 This is a paragraph continuing the details.
This is a blockquote inside the details.
#Tight vs Loose Lists
Markdown supports two types of list formatting: tight and loose lists. The difference between them is determined by whether list items are separated by blank lines or not.
#Tight Lists
Tight lists have no blank lines between list items. They are more compact and are useful for simple, concise lists.
Here's what the above tight list will be created as in the generated website:
- First item
- Second item
- Nested item 1
- Nested item 2
- Third item
#Loose Lists
Loose lists have blank lines between list items. They are useful when list items contain multiple paragraphs or complex content.
Here's what the above loose list will be created as in the generated website:
First item with multiple paragraphs.
This is a second paragraph in the first item.
Second item with nested content.
Nested item 1
Nested item 2
Third item with a blockquote.
This is a blockquote inside a list item.
When mixing tight and loose lists, be aware that the rendering may appear inconsistent. For best results, maintain consistent formatting within nested lists by using either all tight or all loose formatting.
#Generic Attributes
Generic attributes can be applied to list items to customize their appearance, add an id
or any other custom attributes.
To add a custom CSS class, add the generic attribute syntax {.class-name}
to the end of a list item.
#Custom Marker Colors
You can customize the color of list item markers using CSS and generic attributes:
- Item 1 (green)
- Item 2 (yellow)
- Item 3 (red)
#Custom Text Colors
You can also apply a custom color to a list item:
- Item 1
- Item 2 (orange)
- Item 3
#Custom id
A custom id
can be added to the list item by appending the {#id-name}
generic attribute syntax:
The above will create one list item with the custom id
attribute: