From bfed711f54238f7c832880a6fad1203fb0645805 Mon Sep 17 00:00:00 2001 From: David Rosa Date: Tue, 14 Mar 2023 21:28:01 -0600 Subject: [PATCH] help: Add a dedicated page on how to format paragraphs and sections. --- help/format-your-message-using-markdown.md | 20 ++++--------------- .../paragraphs-and-sections-examples.md | 19 ++++++++++++++++++ help/include/paragraphs-and-sections-intro.md | 3 +++ help/include/sidebar_index.md | 1 + help/paragraph-and-section-formatting.md | 13 ++++++++++++ 5 files changed, 40 insertions(+), 16 deletions(-) create mode 100644 help/include/paragraphs-and-sections-examples.md create mode 100644 help/include/paragraphs-and-sections-intro.md create mode 100644 help/paragraph-and-section-formatting.md diff --git a/help/format-your-message-using-markdown.md b/help/format-your-message-using-markdown.md index 6a69fe75bb..c2c90a0f26 100644 --- a/help/format-your-message-using-markdown.md +++ b/help/format-your-message-using-markdown.md @@ -27,7 +27,7 @@ whenever you need a reminder of the formatting syntax below. * [Global times](#global-times) * [Tables](#tables) * [Collaborative to-do lists](#collaborative-to-do-lists) -* [Paragraphs and lines](#paragraphs-and-lines) +* [Paragraph and section formatting](#paragraph-and-section-formatting) ## Text emphasis @@ -116,23 +116,11 @@ whenever you need a reminder of the formatting syntax below. {!to-do-lists-examples.md!} -## Paragraphs and lines +## Paragraph and section formatting -``` -One blank space for a new paragraph -New line, same paragraph +{!paragraphs-and-sections-intro.md!} -New paragraph - ----, ***, or ___ for a horizontal line -Over the line - ---- - -Under the line -``` - -![Markdown paragraph](/static/images/help/markdown-paragraph.png) +{!paragraphs-and-sections-examples.md!} ## Message formatting reference diff --git a/help/include/paragraphs-and-sections-examples.md b/help/include/paragraphs-and-sections-examples.md new file mode 100644 index 0000000000..afcea6bf0d --- /dev/null +++ b/help/include/paragraphs-and-sections-examples.md @@ -0,0 +1,19 @@ +### What you type + +``` +One blank space for a new paragraph +New line, same paragraph + +New paragraph + +---, ***, or ___ for a horizontal line +Over the line + +--- + +Under the line +``` + +### What it looks like + +![Markdown paragraph](/static/images/help/markdown-paragraph.png) diff --git a/help/include/paragraphs-and-sections-intro.md b/help/include/paragraphs-and-sections-intro.md new file mode 100644 index 0000000000..41abfc807c --- /dev/null +++ b/help/include/paragraphs-and-sections-intro.md @@ -0,0 +1,3 @@ +Zulip supports Markdown formatting for paragraphs and visual section breaks, +which you can use to control the layout of your text and to visually separate +different sections of content. diff --git a/help/include/sidebar_index.md b/help/include/sidebar_index.md index b6ae337c38..6132e6bb03 100644 --- a/help/include/sidebar_index.md +++ b/help/include/sidebar_index.md @@ -65,6 +65,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) +* [Paragraph and section formatting](/help/paragraph-and-section-formatting) * [Bulleted and numbered lists](/help/bulleted-and-numbered-lists) * [Tables](/help/tables) * [Code blocks](/help/code-blocks) diff --git a/help/paragraph-and-section-formatting.md b/help/paragraph-and-section-formatting.md new file mode 100644 index 0000000000..e2e737da34 --- /dev/null +++ b/help/paragraph-and-section-formatting.md @@ -0,0 +1,13 @@ +# Paragraph and section formatting + +{!paragraphs-and-sections-intro.md!} + +## Examples + +{!paragraphs-and-sections-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)