help: Add a dedicated page on how to format lists.

- Updates example and screenshot for numbered lists.
This commit is contained in:
David Rosa 2023-03-09 22:03:45 -07:00 committed by Tim Abbott
parent 93bfd3fb5f
commit 4508fb5d5c
5 changed files with 60 additions and 28 deletions

View File

@ -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)

View File

@ -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. whenever you need a reminder of the formatting syntax below.
* [Text emphasis](#text-emphasis) * [Text emphasis](#text-emphasis)
* [Lists](#lists) * [Bulleted lists](#bulleted-lists)
* [Numbered lists](#numbered-lists)
* [Links and images](#links) * [Links and images](#links)
* [Code blocks](#code) * [Code blocks](#code)
* [LaTeX](#latex) * [LaTeX](#latex)
@ -37,33 +38,7 @@ whenever you need a reminder of the formatting syntax below.
<kbd>B</kbd> or <kbd>Ctrl</kbd> + <kbd>I</kbd>) to make text bold or italic. <kbd>B</kbd> or <kbd>Ctrl</kbd> + <kbd>I</kbd>) to make text bold or italic.
[Learn more](/help/text-emphasis). [Learn more](/help/text-emphasis).
## Lists {!format-lists.md!}
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)
## Links ## Links

View File

@ -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)

View File

@ -63,6 +63,7 @@
* [Share and upload files](/help/share-and-upload-files) * [Share and upload files](/help/share-and-upload-files)
* [Add GIFs in your message](/help/animated-gifs-from-giphy) * [Add GIFs in your message](/help/animated-gifs-from-giphy)
* [Text emphasis](/help/text-emphasis) * [Text emphasis](/help/text-emphasis)
* [Bulleted and numbered lists](/help/bulleted-and-numbered-lists)
* [Code blocks](/help/code-blocks) * [Code blocks](/help/code-blocks)
* [Create a poll](/help/create-a-poll) * [Create a poll](/help/create-a-poll)
* [Start a video call](/help/start-a-call) * [Start a video call](/help/start-a-call)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.1 KiB

After

Width:  |  Height:  |  Size: 38 KiB