mirror of https://github.com/zulip/zulip.git
102 lines
3.7 KiB
Markdown
102 lines
3.7 KiB
Markdown
|
# Message formatting
|
||
|
|
|
||
|
|
Zulip uses a variant of GitHub Flavored Markdown (GFM) to allow you to easily format your messages.
|
||
|
|
|
||
|
|
## Summary
|
||
|
|
|
||
|
|
For a summary of message formatting in Zulip, click the  icon located at the bottom left of your messaging box or the cog () in the upper right corner of the right sidebar and choose “Message formatting” from the drop-down menu.
|
||
|
|
|
||
|
|
The following modal window will appear.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Emphasis
|
||
|
|
|
||
|
|
You can surround your test with a combination of asterisks `*` and tildes `~` to emphasize words or phrases in your messages.
|
||
|
|
|
||
|
|
### Italics
|
||
|
|
|
||
|
|
For italics, surround your text with `*asterisks*`.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Bold
|
||
|
|
|
||
|
|
For bold text, surround your text with `**two asterisks**`.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Strikethrough
|
||
|
|
|
||
|
|
For strikethrough text, surround your text with `~~two tildes~~`.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Extra emphasis
|
||
|
|
|
||
|
|
To add more variety, flavor, and emphasis to your messages, you can combine different styles of formatting.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Links
|
||
|
|
|
||
|
|
To include hyperlinks in your messages, you can either enter the link's url address directly or surround the link's display text with`[brackets]` and the url address of the link in `(parentheses)` immediately after.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Zulip currently does not support image embedding through links.
|
||
|
|
|
||
|
|
## Lists
|
||
|
|
|
||
|
|
Begin each item in your list with `* an asterisk followed by a space` to include lists in your messages.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Emojis
|
||
|
|
|
||
|
|
Zulip features a variety of emojis provided by the [Noto Project](https://code.google.com/p/noto/). To include emojis in your messages, surround the emoji phrase with `:colons:`.
|
||
|
|
|
||
|
|
A dropdown will appear with suggested emojis as you enter the emoji phrase.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
A complete list of emojis can be found [here](http://www.webpagefx.com/tools/emoji-cheat-sheet/).
|
||
|
|
|
||
|
|
## Mentions
|
||
|
|
|
||
|
|
To call the attention of another member, you can alert other users by typing `@**username**"`
|
||
|
|
|
||
|
|
If you type `@` and then begin typing their email address or one of their names, and the system will offer you auto-completion suggestions.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Typing `@**all**` will alert all users in the stream, and a confirmation message will appear.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
For more information on mentions, visit [here](/help/mention-a-team-member.md) for more information.
|
||
|
|
|
||
|
|
## Code
|
||
|
|
|
||
|
|
You can surround a portion of code with ``
|
||
|
|
`back-ticks`
|
||
|
|
`` to display it as inline code.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Multi-line blocks of code are either fenced by lines with <code>`````` three back-ticks```<code>```</code></code> or indented with four spaces.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
In addition, to highlight language syntax, add the file extension of the language (for example, Python would be **.py**) right after the first set of back-ticks.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Quotes
|
||
|
|
|
||
|
|
To insert quotes, you can either add a greater-than symbol ```>``` and a space before your phrase or submit it as a quote block by following the code syntax highlighting format.
|
||
|
|
|
||
|
|
|