help: Split documentation for bulleted and numbered lists.

- Splits existing documentation into two pages: Bulleted lists,
  and Numbered lists.

Fixes part of #27093.
This commit is contained in:
David Rosa 2023-10-17 17:41:20 -07:00 committed by Tim Abbott
parent a8e3606c2c
commit 99f2fa9c86
9 changed files with 75 additions and 50 deletions

View File

@ -1,11 +1,14 @@
# Bulleted and numbered lists # Bulleted lists
Zulip supports Markdown formatting for bulleted and numbered lists. {!bulleted-lists-intro.md!}
{!format-lists.md!} ## Examples
{!bulleted-lists-examples.md!}
## Related articles ## Related articles
* [Message formatting](/help/format-your-message-using-markdown) * [Message formatting](/help/format-your-message-using-markdown)
* [Preview messages before sending](/help/preview-your-message-before-sending) * [Preview messages before sending](/help/preview-your-message-before-sending)
* [Resize the compose box](/help/resize-the-compose-box) * [Resize the compose box](/help/resize-the-compose-box)
* [Numbered lists](/help/numbered-lists)

View File

@ -36,11 +36,22 @@ whenever you need a reminder of the formatting syntax below.
{!emphasis-examples.md!} {!emphasis-examples.md!}
!!! tip "" !!! tip ""
You can also use buttons or keyboard shortcuts (<kbd>Ctrl</kbd> + You can also use buttons or keyboard shortcuts (<kbd>Ctrl</kbd> +
<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).
{!format-lists.md!} ## Bulleted lists
{!bulleted-lists-intro.md!}
{!bulleted-lists-examples.md!}
## Numbered lists
{!numbered-lists-intro.md!}
{!numbered-lists-examples.md!}
## Links ## Links
@ -49,6 +60,7 @@ whenever you need a reminder of the formatting syntax below.
{!links-examples.md!} {!links-examples.md!}
!!! tip "" !!! tip ""
You can also use a button or a keyboard shortcut (<kbd>Ctrl</kbd> + You can also use a button or a keyboard shortcut (<kbd>Ctrl</kbd> +
<kbd>Shift</kbd> + <kbd>L</kbd>) to insert a link. <kbd>Shift</kbd> + <kbd>L</kbd>) to insert a link.
[Learn more](/help/insert-a-link). [Learn more](/help/insert-a-link).

View File

@ -0,0 +1,17 @@
### 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)

View File

@ -0,0 +1,3 @@
Zulip supports Markdown formatting for 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.

View File

@ -1,45 +0,0 @@
## 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

@ -0,0 +1,15 @@
### 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

@ -0,0 +1,5 @@
Zulip supports Markdown formatting for 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.

View File

@ -66,7 +66,8 @@
* [Animated GIFs](/help/animated-gifs-from-giphy) * [Animated GIFs](/help/animated-gifs-from-giphy)
* [Text emphasis](/help/text-emphasis) * [Text emphasis](/help/text-emphasis)
* [Paragraph and section formatting](/help/paragraph-and-section-formatting) * [Paragraph and section formatting](/help/paragraph-and-section-formatting)
* [Bulleted and numbered lists](/help/bulleted-and-numbered-lists) * [Bulleted lists](/help/bulleted-lists)
* [Numbered lists](/help/numbered-lists)
* [Tables](/help/tables) * [Tables](/help/tables)
* [Code blocks](/help/code-blocks) * [Code blocks](/help/code-blocks)
* [LaTeX](/help/latex) * [LaTeX](/help/latex)

14
help/numbered-lists.md Normal file
View File

@ -0,0 +1,14 @@
# Numbered lists
{!numbered-lists-intro.md!}
## Examples
{!numbered-lists-examples.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)
* [Bulleted lists](/help/bulleted-lists)