Edgewall Software

Changes between Version 2 and Version 3 of MarkDown


Ignore:
Timestamp:
Apr 8, 2016, 8:46:51 PM (3 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • MarkDown

    v2 v3  
     1[[PageOutline(2-3,Contents)]]
     2
    13= Markdown
    24
    3 [[PageOutline(2-3)]]
    4 
    5 [http://daringfireball.net/projects/markdown/basics/ Markdown] is a semi-structured markup language originally designed for blogs which is now used in several wikis as well.
    6 
    7 It's now widely used in the software developer community because it's the preferred authoring markup used by GitHub and StackOverflow.
     5[http://daringfireball.net/projects/markdown/basics/ Markdown] is a semi-structured markup language originally designed for blogs, which is now used in several wikis as well.
     6
     7It is now widely used in the software developer community, because it is the preferred authoring markup used by GitHub and StackOverflow.
    88See [http://github.github.com/github-flavored-markdown/ Introduction to GFM] and  [http://stackoverflow.com/editing-help/ Markdown help] respectively for what variant is supported in each.
    99
    10 A lot of this is close to WikiCreole, ReST and our own markup. Most of the time, the markdown syntax makes a lot of sense and would fit well with our current syntax (in particular the rules for nesting paragraphs). And the rest is damn interesting as well!
    11 
    12 The new WikiEngine should make it possible to implement optional or conditional support for Markdown, for the features that conflict with the current syntax.
    13 
    14 So let's go through the details of the basic syntax, of the advanced syntax and of its popular extensions.
    15 
     10The syntax shares many similarities with WikiCreole, ReST and our own markup. Therefore, the markdown syntax would fit well with our current syntax, in particular the rules for nesting paragraphs. The new WikiEngine should also make it possible to implement optional or conditional support for Markdown, for the features that conflict with the current syntax.
     11
     12This page lists the details of the basic syntax, the advanced syntax and its popular extensions.
    1613
    1714== [http://daringfireball.net/projects/markdown/basics Basic features]
    1815
    1916=== PARAGRAPHS, HEADERS, BLOCKQUOTES
     17
    2018{{{
    2119A First Level Header
     
    7169}}}
    7270
    73 This is a huge win and one of the main motivator behind the new engine... (see #8140, #1936)
     71This is a huge win and one of the main motivations behind the new engine. (see #8140, #1936)
    7472
    7573=== LINKS
     
    7977This is an [example link](http://example.com/).
    8078}}}
     79
    8180and that:
    8281{{{
     
    8483}}}
    8584
    86 
    8785References:
     86
    8887{{{
    8988I get 10 times more traffic from [Google][1] than from
     
    9998[ny times]: http://www.nytimes.com/
    10099}}}
    101 ... challenging.
    102100
    103101=== IMAGES
     
    110108[id]: /path/to/img.jpg "Title"
    111109}}}
     110
    112111So we'll have to find another way than the usual `!...` for escaping links. In Markdown, it's usually `\` which is used for escaping markup.
    113112
     
    116115[![Build Status](https://secure.travis-ci.org/libgit2/libgit2.png?branch=development)](http://travis-ci.org/libgit2/libgit2)
    117116}}}
    118 i.e. the image link can be written inside the label part of a normal link (like other inline markup).
    119 
    120 ... challenging again! But we also wanted that already for our own TracLinks, see #9123.
    121 
    122 Note that some tricky stuff like {{{[`o]o`](http://example.com)}}} easily confuses the GitHub parser...
    123 
     117
     118i.e. the image link can be written inside the label part of a normal link (like other inline markup), which can be a challenge! But we also wanted that already for our own TracLinks, see #9123.
     119
     120Note that tricky stuff like {{{[`o]o`](http://example.com)}}} easily confuses the GitHub parser.
    124121
    125122=== CODE
     
    127124We have {{{`...`}}} also.
    128125
    129 But see below...
     126But see below.
    130127
    131128== [http://daringfireball.net/projects/markdown/syntax Advanced features]
     
    144141This is another regular paragraph.
    145142}}}
     143
    146144The original spec mention that the content of these elements is not parsed as Markdown, but some [http://michelf.ca/projects/php-markdown/extra/#markdown-attr extensions] allow for it.
    147145
     
    149147
    150148=== BLOCKQUOTES
     149
    151150"Markdown allows you to be lazy and only put the > before the first line of a hard-wrapped paragraph:"
    152151{{{
     
    172171}}}
    173172
    174 Damn, this breaks the base assumption of the [TracDev/Proposals/VerticalHorizontalParsing vertical/horizontal parsing].
    175 
     173This breaks the base assumption of the [TracDev/Proposals/VerticalHorizontalParsing vertical/horizontal parsing].
    176174
    177175=== CODE
     
    181179}}}
    182180
    183 
    184181== [https://help.github.com/articles/github-flavored-markdown GitHub Flavored Markdown]
    185182
     
    192189Sure, perform_complicated_task shouldn't become perform//complicated//task.
    193190
    194 We could even auto-verbatim these...
     191We could even auto-verbatim these.
    195192
    196193=== URL autolinking
    197194
    198 We have.
     195We have this feature already.
    199196
    200197=== Fenced code blocks
     
    216213=== [https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments Task Lists]
    217214
    218 Aha! Thought about them since a long time, and finally GitHub did it...
    219 
    220 It's only possible to support if we're able to rewrite the original wiki text from the parsed data.
     215Aha! Thought about them since a long time, and finally GitHub did it.
     216
     217It's only possible to support it if we're able to rewrite the original wiki text from the parsed data.
    221218
    222219=== Quick quoting
     
    226223=== Name and Team @mentions autocomplete
    227224
    228 Once we have a better notion of users ...
    229 
    230 But `@user` syntax seems to have become the de-facto standard (I would have preferred ~user though).
     225Once we have a better notion of users. But `@user` syntax seems to have become the de-facto standard (I would have preferred ~user though).
    231226
    232227Auto-complete could be used for a great deal of other things (WikiPageNames and WikiMacros, source paths, attachment names, etc. See #9296).
     
    246241=== Closing issues via commit messages
    247242
    248 We have.
     243We have this feature already.
    249244
    250245=== References
     246
    251247{{{
    252248* SHA: be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
     
    257253* User/Project#Num: mojombo/god#1
    258254}}}
    259 References to SHA1 numbers are/should be unique enough for not having to ask the user to add the repository name. However, if it's added then we know explicitly where to go (in case the same commit is present in multiple repositories).
     255
     256References to SHA1 numbers are/should be unique enough for not having to ask the user to add the repository name. However, if it's added, then we know explicitly where to go (in case the same commit is present in multiple repositories).
    260257
    261258== [http://michelf.ca/projects/php-markdown/extra/ Markdown Extra]
     
    273270 * definition lists
    274271 * glossary entries (LaTeX only)
    275  * document metadata (e.g. title, author, etc.)
    276 
    277 
    278 -----
    279 (to be continued)
    280 -----
     272 * document metadata, such as title, author, etc.
     273
    281274== [http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown Pandoc]
    282275
    283 
    284276== [http://www.pell.portland.or.us/~orc/Code/markdown/ Discount]
    285277
    286 
    287278== [http://stackoverflow.com/editing-help StackOverflow extensions]
    288279
    289 
    290280== [http://rdoc.rubyforge.org/RDoc/Markdown.html RDoc Markdown]
    291281