From 45eea0efb69642a451d38157ab03a8cb6a5e9386 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Fri, 16 Nov 2018 10:57:07 -0500 Subject: [PATCH] Add docs for lists --- docs/ui-components/lists.md | 98 +++++++++++++++++++++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 docs/ui-components/lists.md diff --git a/docs/ui-components/lists.md b/docs/ui-components/lists.md new file mode 100644 index 0000000..364316e --- /dev/null +++ b/docs/ui-components/lists.md @@ -0,0 +1,98 @@ +--- +layout: default +title: Lists +parent: UI Components +nav_order: 5 +--- + +# Lists +{:.no_toc} + +## Table of contents +{: .no_toc .text-delta } + +1. TOC +{:toc} + +--- + +Most lists can be rendered with pure markdown... + +## Unordered list +
+- Item 1 +- Item 2 +- Item 3 + +_or_ + +* Item 1 +* Item 2 +* Item 3 +
+```markdown +- Item 1 +- Item 2 +- Item 3 + +_or_ + +* Item 1 +* Item 2 +* Item 3 +``` + + +## Ordered list +
+1. Item 1 +1. Item 2 +1. Item 3 +
+ ```markdown +1. Item 1 +1. Item 2 +1. Item 3 + ``` +## Task list + +
+- [ ] hello, this is a todo item +- [ ] hello, this is another todo item +- [x] goodbye, this item is done +
+ ```markdown +- [ ] hello, this is a todo item +- [ ] hello, this is another todo item +- [x] goodbye, this item is done + ``` + +## Definition list + +Definition lists require HTML syntax and aren't supported with the GitHub flavored markdown compiler. + +
+
+
Name
+
Godzilla
+
Born
+
1952
+
Birthplace
+
Japan
+
Color
+
Green
+
+
+```html +
+
Name
+
Godzilla
+
Born
+
1952
+
Birthplace
+
Japan
+
Color
+
Green
+
+``` +