From 99f2fa9c863eb81384746eec56957e5e32694689 Mon Sep 17 00:00:00 2001 From: David Rosa Date: Tue, 17 Oct 2023 17:41:20 -0700 Subject: [PATCH] help: Split documentation for bulleted and numbered lists. - Splits existing documentation into two pages: Bulleted lists, and Numbered lists. Fixes part of #27093. --- ...nd-numbered-lists.md => bulleted-lists.md} | 9 ++-- help/format-your-message-using-markdown.md | 14 +++++- help/include/bulleted-lists-examples.md | 17 +++++++ help/include/bulleted-lists-intro.md | 3 ++ help/include/format-lists.md | 45 ------------------- help/include/numbered-lists-examples.md | 15 +++++++ help/include/numbered-lists-intro.md | 5 +++ help/include/sidebar_index.md | 3 +- help/numbered-lists.md | 14 ++++++ 9 files changed, 75 insertions(+), 50 deletions(-) rename help/{bulleted-and-numbered-lists.md => bulleted-lists.md} (63%) create mode 100644 help/include/bulleted-lists-examples.md create mode 100644 help/include/bulleted-lists-intro.md delete mode 100644 help/include/format-lists.md create mode 100644 help/include/numbered-lists-examples.md create mode 100644 help/include/numbered-lists-intro.md create mode 100644 help/numbered-lists.md diff --git a/help/bulleted-and-numbered-lists.md b/help/bulleted-lists.md similarity index 63% rename from help/bulleted-and-numbered-lists.md rename to help/bulleted-lists.md index 722dbfcfa4..b8dd29a3dc 100644 --- a/help/bulleted-and-numbered-lists.md +++ b/help/bulleted-lists.md @@ -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 * [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) +* [Numbered lists](/help/numbered-lists) diff --git a/help/format-your-message-using-markdown.md b/help/format-your-message-using-markdown.md index b58ae14522..7b044598ff 100644 --- a/help/format-your-message-using-markdown.md +++ b/help/format-your-message-using-markdown.md @@ -36,11 +36,22 @@ whenever you need a reminder of the formatting syntax below. {!emphasis-examples.md!} !!! tip "" + You can also use buttons or keyboard shortcuts (Ctrl + B or Ctrl + I) to make text bold or italic. [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 @@ -49,6 +60,7 @@ whenever you need a reminder of the formatting syntax below. {!links-examples.md!} !!! tip "" + You can also use a button or a keyboard shortcut (Ctrl + Shift + L) to insert a link. [Learn more](/help/insert-a-link). diff --git a/help/include/bulleted-lists-examples.md b/help/include/bulleted-lists-examples.md new file mode 100644 index 0000000000..f906788ab6 --- /dev/null +++ b/help/include/bulleted-lists-examples.md @@ -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) diff --git a/help/include/bulleted-lists-intro.md b/help/include/bulleted-lists-intro.md new file mode 100644 index 0000000000..330e93a916 --- /dev/null +++ b/help/include/bulleted-lists-intro.md @@ -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. diff --git a/help/include/format-lists.md b/help/include/format-lists.md deleted file mode 100644 index 1393d3f761..0000000000 --- a/help/include/format-lists.md +++ /dev/null @@ -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) diff --git a/help/include/numbered-lists-examples.md b/help/include/numbered-lists-examples.md new file mode 100644 index 0000000000..b6e7f575a9 --- /dev/null +++ b/help/include/numbered-lists-examples.md @@ -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) diff --git a/help/include/numbered-lists-intro.md b/help/include/numbered-lists-intro.md new file mode 100644 index 0000000000..aa990b2099 --- /dev/null +++ b/help/include/numbered-lists-intro.md @@ -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. diff --git a/help/include/sidebar_index.md b/help/include/sidebar_index.md index 3f4d120891..e2b7edae6a 100644 --- a/help/include/sidebar_index.md +++ b/help/include/sidebar_index.md @@ -66,7 +66,8 @@ * [Animated GIFs](/help/animated-gifs-from-giphy) * [Text emphasis](/help/text-emphasis) * [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) * [Code blocks](/help/code-blocks) * [LaTeX](/help/latex) diff --git a/help/numbered-lists.md b/help/numbered-lists.md new file mode 100644 index 0000000000..b6040b6573 --- /dev/null +++ b/help/numbered-lists.md @@ -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)