Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Add reference to tilde-fenced code blocks.

This commit is contained in:
Yago González 2017-03-21 21:46:25 +01:00 committed by Tim Abbott
parent 5e0a906f84
commit 0c6251e58d
2 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
static/images/help/csharp-syntax.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 49 KiB

After

Width:  |  Height:  |  Size: 33 KiB

17
templates/zerver/help/format-your-message-using-markdown.md
View File

@ -104,14 +104,16 @@ For more information on mentions, visit [here](/help/at-mention-a-team-member).
## Code
You can surround a portion of code with ``
`back-ticks`
`` to display it as inline code.
You can surround a portion of code with `` `back-ticks` `` to display it as
inline code.
![Inline code](/static/images/help/inline-code-screenshot.png)
Multi-line blocks of code are either fenced by lines with three back-ticks
(<code>```</code>) or indented with four spaces.
Multi-line blocks of code are either:
- Fenced by lines with three back-ticks (` ``` `).
- Fenced by lines with three tildes (`~~~`).
- Indented with four spaces.
![No code syntax highlighting](/static/images/help/no-syntax.png)
@ -121,6 +123,11 @@ block, add the language's **first**
[Pygments short name](http://pygments.org/docs/lexers/) after the first set of
back-ticks.
!!! warn ""
You can only specify the language's short name in fenced code blocks.
It is not possible to use the syntax highlighter in blocks indented with
spaces.
![Python syntax highlighting](/static/images/help/python-syntax.png)
![JavaScript syntax highlighting](/static/images/help/javascript-syntax.png)