Add some documentation

[etc/vim.git] / test / syntax.md

diff --git a/test/syntax.md b/test/syntax.md
index 9c849e7970c77544113dad08333d3bf2cef05389..33f5500e88716e4e6d7afac4232ca19817e9c5f3 100644 (file)
--- a/test/syntax.md
+++ b/test/syntax.md
@@ -1,159 +1,89 @@
-# Original markdown
+# Fenced code living in an indented environment is correctly highlighted
 
-This section covers only features from the [original markdown](daringfireball.net/projects/markdown/syntax), in the same order that they are defined on the specification.
-
-Extensions will be tested on a separate section.
-
-## Paragraphs
-
-Paragraph.
-
-Line  
-break.
-
-## Headers
-
-The following should be highlighted as headers:
-
-# h1
-
- # h1
-
-# h1 #
-
-h1
-==
-
-## h2
-
-## h2 ##
-
-h2
---
-
-### h3
-
-#### h4
-
-##### h5
-
-###### h6
-
-The following is unspecified by Markdown and may not highlight properly:
-
-####### h7
-
-## Blockquotes
-
-> Block quote
-
-> First line only
-block quote
-
-> Block quote
-> > Block quote level 2
-
-> # Markdown inside block quote
->
-> [Link text](link-url)
-
-## Lists
-
-Only the list marker should be highlighted:
-
-* 0
-* 1
-
-+ 0
-+ 1
-
-- 0
-- 1
+1. run this command to do this:
 
-1. 0
-2. 1
+    ```
+some command
+    ```
 
-*Not* lists:
+2. Subsequent list items are correctly highlighted.
 
-1 0
+Fenced code block with language:
 
- - 0
+```ruby
+def f
+  0
+end
+```
 
-## Links
+# Links
 
-[Link text](link-url)
+[a](b "c")
 
-Reference style link: [Link text][reference]
+[a]()
 
-With space: [Link text] [reference]
+[good spell](a)
 
-[reference]: address
-[reference2]: address "Optional Title"
+[badd spell](a)
 
-## Code blocks
+[a](b "c")
 
-Inline: `inline code`
+[a]( b
+"c" )
 
-Indented:
+a (`a`) b. Fix: <https://github.com/plasticboy/vim-markdown/issues/113>
 
-    indented code block
+Escaped:
 
-    # not a header
+\[a](b)
 
-    - not a list
+[a\]b](c)
 
-Indented code block and lists:
+## Known failures
 
-- 0
+Escape does not work:
 
-    Paragraph.
+[a\](b)
 
-        indented code block inside list
+Should not be links because of whitespace:
 
-- 0
+[a] (b)
 
-    - 1
+[a](a
+b)
 
-        Paragraph (TODO FAIL).
+[a](a b)
 
-            indented code block inside list
+# Reference links
 
-## Emphasis
+Single links:
 
-The following should be italicized:
+[a][b]
 
-*single asterisks*
+[good spell][a]
 
-_single underscores_
+[badd spell][a]
 
-The following should be boldface:
+[a][]
 
-**double asterisks**
+[a] []
 
-__double underscores__
+[a][b] c [d][e]
 
-# Extensions
+Reference link followed by inline link:
 
-Fenced code blocks TODO add option to turn ON/OFF:
+[a] [b](c)
 
-```
-fenced code block
-```
+## Known failures
 
-Fenced code living in an indented environment is correctly highlighted:
+Should be shortcut reference links:
 
-1. run this command to do this:
+[a]
 
-    ```
-some command
-    ```
+[a] b [c]
 
-2. Subsequent list items are correctly highlighted.
+Should be a single link:
 
-Fenced code block with language:
+[a] [b]
 
-```ruby
-def f
-  0
-end
-```
+[a] b [c](d)