help: Update Message formatting documentation.

- Updates intro paragraph in Message formatting page.
- Change Markdown syntax -> Markdown formatting.
- Reorders items in the Writing messages section of the left sidebar.
This commit is contained in:
David Rosa 2023-03-09 21:26:25 -07:00 committed by Tim Abbott
parent b66d8dfd90
commit 2e2747dfac
3 changed files with 15 additions and 10 deletions

View File

@ -3,10 +3,15 @@
[//]: # (All screenshots here require line-height: 22px and font-size: 16px in .message-content.)
[//]: # (Requires some additional fiddling for the LaTeX picture, inline code span, and maybe a few others.)
Zulip uses a variant of Markdown to allow you to easily format your
messages. There is a convenient [**message formatting
reference**](#message-formatting-reference) in the Zulip app that you
can use whenever you need a reminder of the formatting syntax below.
Zulip uses Markdown to allow you to easily format your messages. Even if you've
never heard of Markdown, you are probably familiar with basic Markdown
formatting, such as using `*` at the start of a line in a bulleted list, or
around text to indicate emphasis.
This page provides an overview of all the formatting available in Zulip. There
is a convenient [**message formatting
reference**](#message-formatting-reference) in the Zulip app that you can use
whenever you need a reminder of the formatting syntax below.
* [Emphasis](#emphasis)
* [Lists](#lists)

View File

@ -1,6 +1,6 @@
!!! tip ""
The **organization description** supports [full Markdown syntax][markdown-syntax],
The **organization description** supports [full Markdown formatting][markdown-formatting],
including **bold**/*italic*, links, lists, and more.
!!! tip ""
@ -21,4 +21,4 @@
{end_tabs}
[markdown-syntax]: /help/format-your-message-using-markdown
[markdown-formatting]: /help/format-your-message-using-markdown

View File

@ -58,13 +58,13 @@
## Writing messages
* [Message formatting](/help/format-your-message-using-markdown)
* [Mention a user or group](/help/mention-a-user-or-group)
* [Emoji and emoticons](/help/emoji-and-emoticons)
* [Start a video call](/help/start-a-call)
* [Share and upload files](/help/share-and-upload-files)
* [Quote and reply](/help/quote-and-reply)
* [Code blocks](/help/code-blocks)
* [Emoji and emoticons](/help/emoji-and-emoticons)
* [Share and upload files](/help/share-and-upload-files)
* [Add GIFs in your message](/help/animated-gifs-from-giphy)
* [Code blocks](/help/code-blocks)
* [Create a poll](/help/create-a-poll)
* [Start a video call](/help/start-a-call)
## Sending messages
* [Open the compose box](/help/open-the-compose-box)