diff --git a/help/bulleted-and-numbered-lists.md b/help/bulleted-and-numbered-lists.md new file mode 100644 index 0000000000..722dbfcfa4 --- /dev/null +++ b/help/bulleted-and-numbered-lists.md @@ -0,0 +1,11 @@ +# Bulleted and numbered lists + +Zulip supports Markdown formatting for bulleted and numbered lists. + +{!format-lists.md!} + +## Related articles + +* [Message formatting](/help/format-your-message-using-markdown) +* [Preview messages before sending](/help/preview-your-message-before-sending) +* [Resize the compose box](/help/resize-the-compose-box) diff --git a/help/format-your-message-using-markdown.md b/help/format-your-message-using-markdown.md index 53cdb5448c..32133f038f 100644 --- a/help/format-your-message-using-markdown.md +++ b/help/format-your-message-using-markdown.md @@ -14,7 +14,8 @@ reference**](#message-formatting-reference) in the Zulip app that you can use whenever you need a reminder of the formatting syntax below. * [Text emphasis](#text-emphasis) -* [Lists](#lists) +* [Bulleted lists](#bulleted-lists) +* [Numbered lists](#numbered-lists) * [Links and images](#links) * [Code blocks](#code) * [LaTeX](#latex) @@ -37,33 +38,7 @@ whenever you need a reminder of the formatting syntax below. B or Ctrl + I) to make text bold or italic. [Learn more](/help/text-emphasis). -## Lists - -Bulleted lists -``` -* bulleted lists - * with sub-bullets too - * sub-bullets start with 2 spaces - * start sub-sub-bullets with 4 spaces -* multi -line -bullet -- dashes and -+ pluses are ok too -``` - -![Markdown bullets](/static/images/help/markdown-bullets.png) - -Numbered lists - -``` -1. numbered lists -1. increment automatically -1. one more -``` - -![Markdown numbered lists](/static/images/help/markdown-numbered-lists.png) - +{!format-lists.md!} ## Links diff --git a/help/include/format-lists.md b/help/include/format-lists.md new file mode 100644 index 0000000000..1393d3f761 --- /dev/null +++ b/help/include/format-lists.md @@ -0,0 +1,45 @@ +## Bulleted lists + +You can create bulleted lists using `*`, `-`, or `+` at the start of each line. +Add two spaces before the bullet to create a nested list. + +### What you type + +``` +* bulleted lists + * with sub-bullets too + * sub-bullets start with 2 spaces + * start sub-sub-bullets with 4 spaces +* multi +line +bullet +- dashes and ++ pluses are ok too +``` + +### What it looks like + +![Markdown bullets](/static/images/help/markdown-bullets.png) + +## Numbered lists + +You can create numbered lists by putting a number followed by a `.` at the start +of each line. Lists are numbered automatically, so you can reorder list items +while editing your message without having to update the numbers. Add two spaces +before the number to create a nested list. + +### What you type + +``` +1. numbered lists +1. increment automatically + 1. use nested lists if you like + 3. delete or reorder lines without fixing the numbering +1. one more + 17. lists can start at any number + 18. so you can continue a list after some other text +``` + +### What it looks like + +![Markdown numbered lists](/static/images/help/markdown-numbered-lists.png) diff --git a/help/include/sidebar_index.md b/help/include/sidebar_index.md index c9eb3989bc..d54698f776 100644 --- a/help/include/sidebar_index.md +++ b/help/include/sidebar_index.md @@ -63,6 +63,7 @@ * [Share and upload files](/help/share-and-upload-files) * [Add GIFs in your message](/help/animated-gifs-from-giphy) * [Text emphasis](/help/text-emphasis) +* [Bulleted and numbered lists](/help/bulleted-and-numbered-lists) * [Code blocks](/help/code-blocks) * [Create a poll](/help/create-a-poll) * [Start a video call](/help/start-a-call) diff --git a/static/images/help/markdown-numbered-lists.png b/static/images/help/markdown-numbered-lists.png index 4c3c856af3..3382ddbe97 100644 Binary files a/static/images/help/markdown-numbered-lists.png and b/static/images/help/markdown-numbered-lists.png differ