-
-
The rest of the docs use two blank lines between sections (the exception being a sub-section right after a section header, where there's only one blank line).
Same with ones below.
-
-
This part kind of gets lost without an example. Can we show an example with the 4 space indentation for code blocks as well? Probably with text above it not indented, or it'll be hard to notice :)
-
We're very inconsistent in the docs right now wrt "Markdown" vs" markdown." We should probably use the former, I'm guessing.
Document Markdown support.
Review Request #4834 — Created Oct. 23, 2013 and submitted
Document Markdown support.
This change adds some relatively thorough documentation for using markdown.
The bulk of this is a page called "Using Markdown" which gives a quick overview
of the basics of markdown syntax for the things most people will care about. I
haven't made this an exhaustive document, since the pages on daring fireball
and github serve that purpose. Instead, this should hopefully be a nice quick
reference for the basics of markdown syntax as interpreted by Review Board.This is linked to from all the various places where markdown can be used.
While I was in here, I updated everything to capitalize "Markdown", including
in the MD review UI docs, and capitalized the terms in the glossary (which
looks much better to me).
- Generated HTML docs and read through everything.
- Checked cross-linking.
| Description | From | Last Updated |
|---|---|---|
|
The rest of the docs use two blank lines between sections (the exception being a sub-section right after a section … |
 chipx86
|
|
|
This will show italics. It needs to be **emphasized** |
chipx86
|
|
|
This part kind of gets lost without an example. Can we show an example with the 4 space indentation for … |
chipx86
|
|
|
We're very inconsistent in the docs right now wrt "Markdown" vs" markdown." We should probably use the former, I'm guessing. |
chipx86
|
- Description:
-
Document Markdown support.
This change adds some relatively thorough documentation for using markdown.
The bulk of this is a page called "Using Markdown" which gives a quick overview of the basics of markdown syntax for the things most people will care about. I haven't made this an exhaustive document, since the pages on daring fireball and github serve that purpose. Instead, this should hopefully be a nice quick reference for the basics of markdown syntax as interpreted by Review Board. This is linked to from all the various places where markdown can be used.
+ + While I was in here, I updated everything to capitalize "Markdown", including
+ in the MD review UI docs, and capitalized the terms in the glossary (which + looks much better to me). - Diff:
-
Revision 2 (+210 -16)