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

docs: Minor fixes on Zulip's Markdown.

This commit is contained in:
Yago González 2017-02-14 20:23:34 +00:00 committed by Tim Abbott
parent a2e9572200
commit 1861f02de7
1 changed files with 18 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/markdown.md
View File

@ -121,16 +121,17 @@ be non-standard.
### Basic syntax ### Basic syntax
* Enable `nl2br</tt> extension: this means one newline creates a line * Enable `nl2br` extension: this means one newline creates a line
break (not paragraph break). break (not paragraph break).
* Disable italics entirely. This resolves an issue where people were * Allow only `*` syntax for italics, not `_`. This resolves an issue where
using `*` and `_` and hitting it by mistake too often. E.g. with people were using `_` and hitting it by mistake too often. Asterisks
stock Markdown `You should use char * instead of void * there` would surrounded by spaces won't trigger italics, either (e.g. with stock Markdown
trigger italics. `You should use char * instead of void * there` would produce undesired
results).
* Allow only `**` syntax for bold, not `__` (easy to hit by mistake if * Allow only `**` syntax for bold, not `__` (easy to hit by mistake if
discussing Python `__init__` or something) discussing Python `__init__` or something).
* Add `~~` syntax for strikethrough. * Add `~~` syntax for strikethrough.
@ -142,14 +143,14 @@ be non-standard.
### Lists ### Lists
* Allow tacking a bulleted list or block quote onto the end of a * Allow tacking a bulleted list or block quote onto the end of a
paragraph, i.e. without a blank line before it paragraph, i.e. without a blank line before it.
* Allow only `*` for bulleted lists, not `+` or `-` (previously * Allow only `*` for bulleted lists, not `+` or `-` (previously
created confusion with diff-style text sloppily not included in a created confusion with diff-style text sloppily not included in a
code block) code block).
* Disable ordered list syntax: it automatically renumbers, which can * Disable ordered list syntax: stock Markdown automatically renumbers, which
be really confusing when sending a numbered list across multiple can be really confusing when sending a numbered list across multiple
messages. messages.
### Links ### Links
@ -162,16 +163,17 @@ be non-standard.
is the default behavior. is the default behavior.
* Set `target="_blank"` and `title=`(the url) on every link tag so * Set `target="_blank"` and `title=`(the url) on every link tag so
clicking always opens a new window clicking always opens a new window.
* Disable link-by-reference syntax, `[foo][bar]` ... `[bar]: http://google.com` * Disable link-by-reference syntax,
`[foo][bar]` ... `[bar]: http://google.com`.
* Enable linking to other streams using `#**streamName**` * Enable linking to other streams using `#**streamName**`.
### Code ### Code
* Enable fenced code block extension, with syntax highlighting * Enable fenced code block extension, with syntax highlighting.
* Disable line-numbering within fenced code blocks -- the `<table>` * Disable line-numbering within fenced code blocks -- the `<table>`
output confused our web client code. output confused our web client code.
@ -181,7 +183,8 @@ be non-standard.
* Disable headings, both `# foo` and `== foo ==` syntax: they don't * Disable headings, both `# foo` and `== foo ==` syntax: they don't
make much sense for chat messages. make much sense for chat messages.
* Disabled images. * Disabled images with `![]()` (images from links are shown as an inline
preview).
* Allow embedding any avatar as a tiny (list bullet size) image. This * Allow embedding any avatar as a tiny (list bullet size) image. This
is used primarily by version control integrations. is used primarily by version control integrations.