From 1b2aa7eaa27b79561536720f58d6908bb37937d8 Mon Sep 17 00:00:00 2001 From: Ivan Akimov Date: Thu, 29 Feb 2024 13:09:18 -0600 Subject: [PATCH] readme --- CHANGELOG.md | 3 +++ README.md | 18 ++++++++++++++++++ 2 files changed, 21 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8084c39..0cd6608 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,8 @@ # CHANGELOG +**Unreleased:** +- `README.md`: markdown supports ordered/unordered lists + **v0.1.4:** - `README.md` cleanup (listing of components) - `Image` component now requires only `src`; the other params are optional diff --git a/README.md b/README.md index c85a06a..1f1e65f 100644 --- a/README.md +++ b/README.md @@ -128,6 +128,22 @@ Text component allow you to insert a paragraph. Each paragraph supports basic ma - `# Big Header` - `###### Small Header` +- Unordered list: + + ```md + - item one + - item two + - item three + ``` + +- Ordered list: + + ```md + 1. item one + 1. item two + 1. item three + ``` + ```cs Content.Builder() .Text("## Thank you for signing up") @@ -254,6 +270,8 @@ Content.Builder() +--- + Components can be placed in the header, body and footer of the email. Header and footer styling is usually a bit different from the body (for example the text is smaller). ```cs