more comments;
authorwenzelm
Thu Oct 15 13:48:47 2015 +0200 (2015-10-15)
changeset 6144825e40e78f6d4
parent 61447 7cf8b604280f
child 61449 4f31f79cf2d1
more comments;
src/Pure/Thy/markdown.ML
     1.1 --- a/src/Pure/Thy/markdown.ML	Thu Oct 15 13:28:48 2015 +0200
     1.2 +++ b/src/Pure/Thy/markdown.ML	Thu Oct 15 13:48:47 2015 +0200
     1.3 @@ -1,7 +1,20 @@
     1.4  (*  Title:      Pure/Thy/markdown.ML
     1.5      Author:     Makarius
     1.6  
     1.7 -Minimal support for Markdown documents (see also http://commonmark.org).
     1.8 +Minimal support for Markdown documents (see also http://commonmark.org)
     1.9 +that consist only of paragraphs and (nested) lists:
    1.10 +
    1.11 +  * list items start with marker \<^item> (itemize), \<^enum> (enumerate), \<^descr> (description)
    1.12 +  * adjacent list items with same indentation and same marker are grouped
    1.13 +    into a single list
    1.14 +  * singleton blank lines separate paragraphs
    1.15 +  * multiple blank lines escape from the current list hierarchy
    1.16 +
    1.17 +Notable differences to official Markdown:
    1.18 +
    1.19 +  * indentation of list items needs to match exactly
    1.20 +  * indentation is unlimited (Markdown interprets 4 spaces as block quote)
    1.21 +  * list items always consist of paragraphs -- no notion of "tight" list
    1.22  *)
    1.23  
    1.24  signature MARKDOWN =