aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/org/in_progress/sisu_markdown.org
blob: 0171f236ab9265fcfd57dbf53cc6f6600165e412 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
***** urls

#% markdown
<http://daringfireball.net/projects/markdown/>
<http://daringfireball.net/projects/markdown/syntax>
<http://daringfireball.net/projects/markdown/basics>
<http://en.wikipedia.org/wiki/Markdown>
<https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet>
<http://whatismarkdown.com/>

Markdown supports two styles of headers, Setext and atx
Setext
<http://docutils.sourceforge.net/mirror/setext.html>
<http://en.wikipedia.org/wiki/Setext>
atx
<http://www.aaronsw.com/2002/atx/intro>

<http://support.iawriter.com/help/kb/general-questions/markdown-syntax-reference-guide>
<http://bywordapp.com/markdown/syntax.html>
<http://stackoverflow.com/editing-help>

<http://support.mashery.com/docs/customizing_your_portal/Markdown_Cheat_Sheet>
<http://warpedvisions.org/projects/markdown-cheat-sheet.md>
<http://nestacms.com/docs/creating-content/markdown-cheat-sheet>
<https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet>

<https://help.github.com/articles/github-flavored-markdown>
<http://lifehacker.com/5943320/what-is-markdown-and-why-is-it-better-for-my-to+do-lists-and-notes>

#% pandoc markdown
<http://johnmacfarlane.net/pandoc/demo/example9/pandocs-markdown.html>
<http://johnmacfarlane.net/pandoc/README.html>
<http://johnmacfarlane.net/pandoc/demo/example19/Pandoc_0027s-markdown.html>
<http://johnmacfarlane.net/pandoc/>
<http://johnmacfarlane.net/pandoc/epub.html>
<http://johnmacfarlane.net/pandoc/faqs.html>

#% multimarkdown
<http://fletcher.github.io/peg-multimarkdown/>

#% markdown pandoc v multimarkdown
<https://github.com/jgm/pandoc/wiki/Pandoc-vs-Multimarkdown>

#% rST v markdown
<http://stackoverflow.com/questions/34276/markdown-versus-restructuredtext>

***** rb file
lib/sisu/v6/txt_markdown.rb

***** transformations :transformations:markup_markdown: #%
#% structure - headings, levels
  [] sisu (A-C, 1-3)
  [] collapsed (1-6) (decoration)
    [inline 1-5]
      '#'
      '##'
      '###'
      '####'
      '#####'
      '######'
    [underscore 1-5]
      '='
      '-'
      #'~'
      #'^'
      #'+'
  [] node (child, parent ...)

#% font face
  [open & close marks]
  [] bold
      '**'
  [] italics
      '*'
  [] underscore
      ''
  [] superscript
      ''
  [] subscript
      ''
  [] strike
      ''
  [] add
  [] monospace
      '`'

#% para
  [] default
  [] indent
    [] default, all
    [] first line hang or indent further
  [] bullet
      '*'
  [] numbered list
      '0.'

#% blocks
  [] code
    '    ' #indent at least 4 spaces
    [] [type of markup if any]
  [] poem
  [] group
  [] alt
  [] tables

#% notes
  [] footnotes
    [] [bibliography?]

#% links, linking
  [] links - external, web, url
  [] links - internal

#% images [multimedia?]
  [] images
    [] [base 64]

#% object numbers
  [] ocn (object numbers)

#% contents
  [] toc (table of contents)
  [] index (book index)

#% breaks
  [] line break
  [] horizontal rule
      (three or more asterisks hypens or underscores)
      * * *
      ***
      *****
      - - -
    ___
  [] column break
  [] page break

#% misc