#3532 Add more details to the markdown formatting help

unreleased
open
nobody
None
General
nobody
2015-03-11
2012-01-05
Chris Tsai
No

The Markdown documentation on Daring Fireball includes information on inserting a line break, but our syntax guide does not.

We should include include that you can either end a line with two or more spaces, or use the html tag <br /> to insert a line break.

http://daringfireball.net/projects/markdown/syntax#p

We should also document using ~~~~ for a preformatted block of code, rather than indenting with 4 spaces.

A few "gotchas" are that you need a blank line before list, and need a text paragraph between list and code.

Discussion

  • Anonymous - 2012-02-17

    Originally by: scoop

    • milestone: dir-backlog --> dir-feb-24
     

  • Anonymous - 2012-02-21

    Originally by: scoop

    • milestone: dir-feb-24 --> forge-backlog
     

  • Dave Brondsema

    Dave Brondsema - 2012-09-05
    • summary: Markdown guide should include line break info --> Add more details to the markdown formatting help
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -3,3 +3,7 @@
 We should include include that you can either end a line with two or more spaces, or use the html tag `<br />` to insert a line break.

 http://daringfireball.net/projects/markdown/syntax#p
+
+We should also document using `~~~~` for a preformatted block of code, rather than indenting with 4 spaces.
+
+A few "gotchas" are that you need a blank line before list, and need a text paragraph between list and code.
     

Log in to post a comment.