greenmat 3.2.0.1 → 3.2.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +9 -0
- data/.rspec +2 -0
- data/.travis.yml +14 -0
- data/CHANGELOG.md +15 -0
- data/greenmat.gemspec +3 -47
- data/lib/greenmat/cli.rb +86 -0
- data/lib/greenmat/version.rb +3 -0
- data/spec/greenmat/markdown_spec.rb +65 -0
- data/spec/spec_helper.rb +90 -0
- data/tasks/generate_xcode_project.rake +5 -0
- data/tasks/greenmat.rake +65 -0
- data/tasks/spec.rake +5 -0
- data/test/MarkdownTest_1.0.3/MarkdownTest.pl +181 -0
- data/test/MarkdownTest_1.0.3/Tests/Amps and angle encoding.html +17 -0
- data/test/MarkdownTest_1.0.3/Tests/Amps and angle encoding.text +21 -0
- data/test/MarkdownTest_1.0.3/Tests/Auto links.html +18 -0
- data/test/MarkdownTest_1.0.3/Tests/Auto links.text +13 -0
- data/test/MarkdownTest_1.0.3/Tests/Backslash escapes.html +118 -0
- data/test/MarkdownTest_1.0.3/Tests/Backslash escapes.text +120 -0
- data/test/MarkdownTest_1.0.3/Tests/Blockquotes with code blocks.html +15 -0
- data/test/MarkdownTest_1.0.3/Tests/Blockquotes with code blocks.text +11 -0
- data/test/MarkdownTest_1.0.3/Tests/Code Blocks.html +18 -0
- data/test/MarkdownTest_1.0.3/Tests/Code Blocks.text +14 -0
- data/test/MarkdownTest_1.0.3/Tests/Code Spans.html +6 -0
- data/test/MarkdownTest_1.0.3/Tests/Code Spans.text +6 -0
- data/test/MarkdownTest_1.0.3/Tests/Hard-wrapped paragraphs with list-like lines.html +8 -0
- data/test/MarkdownTest_1.0.3/Tests/Hard-wrapped paragraphs with list-like lines.text +8 -0
- data/test/MarkdownTest_1.0.3/Tests/Horizontal rules.html +71 -0
- data/test/MarkdownTest_1.0.3/Tests/Horizontal rules.text +67 -0
- data/test/MarkdownTest_1.0.3/Tests/Inline HTML (Advanced).html +15 -0
- data/test/MarkdownTest_1.0.3/Tests/Inline HTML (Advanced).text +15 -0
- data/test/MarkdownTest_1.0.3/Tests/Inline HTML (Simple).html +72 -0
- data/test/MarkdownTest_1.0.3/Tests/Inline HTML (Simple).text +69 -0
- data/test/MarkdownTest_1.0.3/Tests/Inline HTML comments.html +13 -0
- data/test/MarkdownTest_1.0.3/Tests/Inline HTML comments.text +13 -0
- data/test/MarkdownTest_1.0.3/Tests/Links, inline style.html +11 -0
- data/test/MarkdownTest_1.0.3/Tests/Links, inline style.text +12 -0
- data/test/MarkdownTest_1.0.3/Tests/Links, reference style.html +52 -0
- data/test/MarkdownTest_1.0.3/Tests/Links, reference style.text +71 -0
- data/test/MarkdownTest_1.0.3/Tests/Links, shortcut references.html +9 -0
- data/test/MarkdownTest_1.0.3/Tests/Links, shortcut references.text +20 -0
- data/test/MarkdownTest_1.0.3/Tests/Literal quotes in titles.html +3 -0
- data/test/MarkdownTest_1.0.3/Tests/Literal quotes in titles.text +7 -0
- data/test/MarkdownTest_1.0.3/Tests/Markdown Documentation - Basics.html +314 -0
- data/test/MarkdownTest_1.0.3/Tests/Markdown Documentation - Basics.text +306 -0
- data/test/MarkdownTest_1.0.3/Tests/Markdown Documentation - Syntax.html +942 -0
- data/test/MarkdownTest_1.0.3/Tests/Markdown Documentation - Syntax.text +888 -0
- data/test/MarkdownTest_1.0.3/Tests/Nested blockquotes.html +9 -0
- data/test/MarkdownTest_1.0.3/Tests/Nested blockquotes.text +5 -0
- data/test/MarkdownTest_1.0.3/Tests/Ordered and unordered lists.html +148 -0
- data/test/MarkdownTest_1.0.3/Tests/Ordered and unordered lists.text +131 -0
- data/test/MarkdownTest_1.0.3/Tests/Strong and em together.html +7 -0
- data/test/MarkdownTest_1.0.3/Tests/Strong and em together.text +7 -0
- data/test/MarkdownTest_1.0.3/Tests/Tabs.html +25 -0
- data/test/MarkdownTest_1.0.3/Tests/Tabs.text +21 -0
- data/test/MarkdownTest_1.0.3/Tests/Tidyness.html +8 -0
- data/test/MarkdownTest_1.0.3/Tests/Tidyness.text +5 -0
- data/test/MarkdownTest_1.0/MarkdownTest.pl +162 -0
- data/test/MarkdownTest_1.0/Tests/Amps and angle encoding.html +17 -0
- data/test/MarkdownTest_1.0/Tests/Amps and angle encoding.text +21 -0
- data/test/MarkdownTest_1.0/Tests/Auto links.html +18 -0
- data/test/MarkdownTest_1.0/Tests/Auto links.text +13 -0
- data/test/MarkdownTest_1.0/Tests/Backslash escapes.html +102 -0
- data/test/MarkdownTest_1.0/Tests/Backslash escapes.text +104 -0
- data/test/MarkdownTest_1.0/Tests/Blockquotes with code blocks.html +15 -0
- data/test/MarkdownTest_1.0/Tests/Blockquotes with code blocks.text +11 -0
- data/test/MarkdownTest_1.0/Tests/Hard-wrapped paragraphs with list-like lines.html +8 -0
- data/test/MarkdownTest_1.0/Tests/Hard-wrapped paragraphs with list-like lines.text +8 -0
- data/test/MarkdownTest_1.0/Tests/Horizontal rules.html +71 -0
- data/test/MarkdownTest_1.0/Tests/Horizontal rules.text +67 -0
- data/test/MarkdownTest_1.0/Tests/Inline HTML (Advanced).html +14 -0
- data/test/MarkdownTest_1.0/Tests/Inline HTML (Advanced).text +14 -0
- data/test/MarkdownTest_1.0/Tests/Inline HTML (Simple).html +72 -0
- data/test/MarkdownTest_1.0/Tests/Inline HTML (Simple).text +69 -0
- data/test/MarkdownTest_1.0/Tests/Inline HTML comments.html +13 -0
- data/test/MarkdownTest_1.0/Tests/Inline HTML comments.text +13 -0
- data/test/MarkdownTest_1.0/Tests/Links, inline style.html +9 -0
- data/test/MarkdownTest_1.0/Tests/Links, inline style.text +9 -0
- data/test/MarkdownTest_1.0/Tests/Links, reference style.html +18 -0
- data/test/MarkdownTest_1.0/Tests/Links, reference style.text +31 -0
- data/test/MarkdownTest_1.0/Tests/Literal quotes in titles.html +3 -0
- data/test/MarkdownTest_1.0/Tests/Literal quotes in titles.text +7 -0
- data/test/MarkdownTest_1.0/Tests/Markdown Documentation - Basics.html +314 -0
- data/test/MarkdownTest_1.0/Tests/Markdown Documentation - Basics.text +306 -0
- data/test/MarkdownTest_1.0/Tests/Markdown Documentation - Syntax.html +942 -0
- data/test/MarkdownTest_1.0/Tests/Markdown Documentation - Syntax.text +888 -0
- data/test/MarkdownTest_1.0/Tests/Nested blockquotes.html +9 -0
- data/test/MarkdownTest_1.0/Tests/Nested blockquotes.text +5 -0
- data/test/MarkdownTest_1.0/Tests/Ordered and unordered lists.html +137 -0
- data/test/MarkdownTest_1.0/Tests/Ordered and unordered lists.text +122 -0
- data/test/MarkdownTest_1.0/Tests/Strong and em together.html +7 -0
- data/test/MarkdownTest_1.0/Tests/Strong and em together.text +7 -0
- data/test/MarkdownTest_1.0/Tests/Tabs.html +25 -0
- data/test/MarkdownTest_1.0/Tests/Tabs.text +21 -0
- data/test/MarkdownTest_1.0/Tests/Tidyness.html +8 -0
- data/test/MarkdownTest_1.0/Tests/Tidyness.text +5 -0
- data/test/fixtures/benchmark.md +232 -0
- data/test/greenmat_bin_test.rb +80 -0
- metadata +186 -1
@@ -0,0 +1,137 @@
|
|
1
|
+
<h2>Unordered</h2>
|
2
|
+
|
3
|
+
<p>Asterisks tight:</p>
|
4
|
+
|
5
|
+
<ul>
|
6
|
+
<li>asterisk 1</li>
|
7
|
+
<li>asterisk 2</li>
|
8
|
+
<li>asterisk 3</li>
|
9
|
+
</ul>
|
10
|
+
|
11
|
+
<p>Asterisks loose:</p>
|
12
|
+
|
13
|
+
<ul>
|
14
|
+
<li><p>asterisk 1</p></li>
|
15
|
+
<li><p>asterisk 2</p></li>
|
16
|
+
<li><p>asterisk 3</p></li>
|
17
|
+
</ul>
|
18
|
+
|
19
|
+
<hr />
|
20
|
+
|
21
|
+
<p>Pluses tight:</p>
|
22
|
+
|
23
|
+
<ul>
|
24
|
+
<li>Plus 1</li>
|
25
|
+
<li>Plus 2</li>
|
26
|
+
<li>Plus 3</li>
|
27
|
+
</ul>
|
28
|
+
|
29
|
+
<p>Pluses loose:</p>
|
30
|
+
|
31
|
+
<ul>
|
32
|
+
<li><p>Plus 1</p></li>
|
33
|
+
<li><p>Plus 2</p></li>
|
34
|
+
<li><p>Plus 3</p></li>
|
35
|
+
</ul>
|
36
|
+
|
37
|
+
<hr />
|
38
|
+
|
39
|
+
<p>Minuses tight:</p>
|
40
|
+
|
41
|
+
<ul>
|
42
|
+
<li>Minus 1</li>
|
43
|
+
<li>Minus 2</li>
|
44
|
+
<li>Minus 3</li>
|
45
|
+
</ul>
|
46
|
+
|
47
|
+
<p>Minuses loose:</p>
|
48
|
+
|
49
|
+
<ul>
|
50
|
+
<li><p>Minus 1</p></li>
|
51
|
+
<li><p>Minus 2</p></li>
|
52
|
+
<li><p>Minus 3</p></li>
|
53
|
+
</ul>
|
54
|
+
|
55
|
+
<h2>Ordered</h2>
|
56
|
+
|
57
|
+
<p>Tight:</p>
|
58
|
+
|
59
|
+
<ol>
|
60
|
+
<li>First</li>
|
61
|
+
<li>Second</li>
|
62
|
+
<li>Third</li>
|
63
|
+
</ol>
|
64
|
+
|
65
|
+
<p>and:</p>
|
66
|
+
|
67
|
+
<ol>
|
68
|
+
<li>One</li>
|
69
|
+
<li>Two</li>
|
70
|
+
<li>Three</li>
|
71
|
+
</ol>
|
72
|
+
|
73
|
+
<p>Loose using tabs:</p>
|
74
|
+
|
75
|
+
<ol>
|
76
|
+
<li><p>First</p></li>
|
77
|
+
<li><p>Second</p></li>
|
78
|
+
<li><p>Third</p></li>
|
79
|
+
</ol>
|
80
|
+
|
81
|
+
<p>and using spaces:</p>
|
82
|
+
|
83
|
+
<ol>
|
84
|
+
<li><p>One</p></li>
|
85
|
+
<li><p>Two</p></li>
|
86
|
+
<li><p>Three</p></li>
|
87
|
+
</ol>
|
88
|
+
|
89
|
+
<p>Multiple paragraphs:</p>
|
90
|
+
|
91
|
+
<ol>
|
92
|
+
<li><p>Item 1, graf one.</p>
|
93
|
+
|
94
|
+
<p>Item 2. graf two. The quick brown fox jumped over the lazy dog's
|
95
|
+
back.</p></li>
|
96
|
+
<li><p>Item 2.</p></li>
|
97
|
+
<li><p>Item 3.</p></li>
|
98
|
+
</ol>
|
99
|
+
|
100
|
+
<h2>Nested</h2>
|
101
|
+
|
102
|
+
<ul>
|
103
|
+
<li>Tab
|
104
|
+
<ul>
|
105
|
+
<li>Tab
|
106
|
+
<ul>
|
107
|
+
<li>Tab</li>
|
108
|
+
</ul></li>
|
109
|
+
</ul></li>
|
110
|
+
</ul>
|
111
|
+
|
112
|
+
<p>Here's another:</p>
|
113
|
+
|
114
|
+
<ol>
|
115
|
+
<li>First</li>
|
116
|
+
<li>Second:
|
117
|
+
<ul>
|
118
|
+
<li>Fee</li>
|
119
|
+
<li>Fie</li>
|
120
|
+
<li>Foe</li>
|
121
|
+
</ul></li>
|
122
|
+
<li>Third</li>
|
123
|
+
</ol>
|
124
|
+
|
125
|
+
<p>Same thing but with paragraphs:</p>
|
126
|
+
|
127
|
+
<ol>
|
128
|
+
<li><p>First</p></li>
|
129
|
+
<li><p>Second:</p>
|
130
|
+
|
131
|
+
<ul>
|
132
|
+
<li>Fee</li>
|
133
|
+
<li>Fie</li>
|
134
|
+
<li>Foe</li>
|
135
|
+
</ul></li>
|
136
|
+
<li><p>Third</p></li>
|
137
|
+
</ol>
|
@@ -0,0 +1,122 @@
|
|
1
|
+
## Unordered
|
2
|
+
|
3
|
+
Asterisks tight:
|
4
|
+
|
5
|
+
* asterisk 1
|
6
|
+
* asterisk 2
|
7
|
+
* asterisk 3
|
8
|
+
|
9
|
+
|
10
|
+
Asterisks loose:
|
11
|
+
|
12
|
+
* asterisk 1
|
13
|
+
|
14
|
+
* asterisk 2
|
15
|
+
|
16
|
+
* asterisk 3
|
17
|
+
|
18
|
+
* * *
|
19
|
+
|
20
|
+
Pluses tight:
|
21
|
+
|
22
|
+
+ Plus 1
|
23
|
+
+ Plus 2
|
24
|
+
+ Plus 3
|
25
|
+
|
26
|
+
|
27
|
+
Pluses loose:
|
28
|
+
|
29
|
+
+ Plus 1
|
30
|
+
|
31
|
+
+ Plus 2
|
32
|
+
|
33
|
+
+ Plus 3
|
34
|
+
|
35
|
+
* * *
|
36
|
+
|
37
|
+
|
38
|
+
Minuses tight:
|
39
|
+
|
40
|
+
- Minus 1
|
41
|
+
- Minus 2
|
42
|
+
- Minus 3
|
43
|
+
|
44
|
+
|
45
|
+
Minuses loose:
|
46
|
+
|
47
|
+
- Minus 1
|
48
|
+
|
49
|
+
- Minus 2
|
50
|
+
|
51
|
+
- Minus 3
|
52
|
+
|
53
|
+
|
54
|
+
## Ordered
|
55
|
+
|
56
|
+
Tight:
|
57
|
+
|
58
|
+
1. First
|
59
|
+
2. Second
|
60
|
+
3. Third
|
61
|
+
|
62
|
+
and:
|
63
|
+
|
64
|
+
1. One
|
65
|
+
2. Two
|
66
|
+
3. Three
|
67
|
+
|
68
|
+
|
69
|
+
Loose using tabs:
|
70
|
+
|
71
|
+
1. First
|
72
|
+
|
73
|
+
2. Second
|
74
|
+
|
75
|
+
3. Third
|
76
|
+
|
77
|
+
and using spaces:
|
78
|
+
|
79
|
+
1. One
|
80
|
+
|
81
|
+
2. Two
|
82
|
+
|
83
|
+
3. Three
|
84
|
+
|
85
|
+
Multiple paragraphs:
|
86
|
+
|
87
|
+
1. Item 1, graf one.
|
88
|
+
|
89
|
+
Item 2. graf two. The quick brown fox jumped over the lazy dog's
|
90
|
+
back.
|
91
|
+
|
92
|
+
2. Item 2.
|
93
|
+
|
94
|
+
3. Item 3.
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
## Nested
|
99
|
+
|
100
|
+
* Tab
|
101
|
+
* Tab
|
102
|
+
* Tab
|
103
|
+
|
104
|
+
Here's another:
|
105
|
+
|
106
|
+
1. First
|
107
|
+
2. Second:
|
108
|
+
* Fee
|
109
|
+
* Fie
|
110
|
+
* Foe
|
111
|
+
3. Third
|
112
|
+
|
113
|
+
Same thing but with paragraphs:
|
114
|
+
|
115
|
+
1. First
|
116
|
+
|
117
|
+
2. Second:
|
118
|
+
* Fee
|
119
|
+
* Fie
|
120
|
+
* Foe
|
121
|
+
|
122
|
+
3. Third
|
@@ -0,0 +1,25 @@
|
|
1
|
+
<ul>
|
2
|
+
<li><p>this is a list item
|
3
|
+
indented with tabs</p></li>
|
4
|
+
<li><p>this is a list item
|
5
|
+
indented with spaces</p></li>
|
6
|
+
</ul>
|
7
|
+
|
8
|
+
<p>Code:</p>
|
9
|
+
|
10
|
+
<pre><code>this code block is indented by one tab
|
11
|
+
</code></pre>
|
12
|
+
|
13
|
+
<p>And:</p>
|
14
|
+
|
15
|
+
<pre><code> this code block is indented by two tabs
|
16
|
+
</code></pre>
|
17
|
+
|
18
|
+
<p>And:</p>
|
19
|
+
|
20
|
+
<pre><code>+ this is an example list item
|
21
|
+
indented with tabs
|
22
|
+
|
23
|
+
+ this is an example list item
|
24
|
+
indented with spaces
|
25
|
+
</code></pre>
|
@@ -0,0 +1,21 @@
|
|
1
|
+
+ this is a list item
|
2
|
+
indented with tabs
|
3
|
+
|
4
|
+
+ this is a list item
|
5
|
+
indented with spaces
|
6
|
+
|
7
|
+
Code:
|
8
|
+
|
9
|
+
this code block is indented by one tab
|
10
|
+
|
11
|
+
And:
|
12
|
+
|
13
|
+
this code block is indented by two tabs
|
14
|
+
|
15
|
+
And:
|
16
|
+
|
17
|
+
+ this is an example list item
|
18
|
+
indented with tabs
|
19
|
+
|
20
|
+
+ this is an example list item
|
21
|
+
indented with spaces
|
@@ -0,0 +1,232 @@
|
|
1
|
+
Download
|
2
|
+
--------
|
3
|
+
|
4
|
+
[Markdown 1.0.1][dl] (18 KB) -- 17 Dec 2004
|
5
|
+
|
6
|
+
[dl]: http://daringfireball.net/projects/downloads/Markdown_1.0.1.zip
|
7
|
+
|
8
|
+
|
9
|
+
Introduction
|
10
|
+
------------
|
11
|
+
|
12
|
+
Markdown is a text-to-HTML conversion tool for web writers. Markdown
|
13
|
+
allows you to write using an easy-to-read, easy-to-write plain text
|
14
|
+
format, then convert it to structurally valid XHTML (or HTML).
|
15
|
+
|
16
|
+
Thus, "Markdown" is two things: (1) a plain text formatting syntax;
|
17
|
+
and (2) a software tool, written in Perl, that converts the plain text
|
18
|
+
formatting to HTML. See the [Syntax][] page for details pertaining to
|
19
|
+
Markdown's formatting syntax. You can try it out, right now, using the
|
20
|
+
online [Dingus][].
|
21
|
+
|
22
|
+
[syntax]: /projects/markdown/syntax
|
23
|
+
[dingus]: /projects/markdown/dingus
|
24
|
+
|
25
|
+
The overriding design goal for Markdown's formatting syntax is to make
|
26
|
+
it as readable as possible. The idea is that a Markdown-formatted
|
27
|
+
document should be publishable as-is, as plain text, without looking
|
28
|
+
like it's been marked up with tags or formatting instructions. While
|
29
|
+
Markdown's syntax has been influenced by several existing text-to-HTML
|
30
|
+
filters, the single biggest source of inspiration for Markdown's
|
31
|
+
syntax is the format of plain text email.
|
32
|
+
|
33
|
+
The best way to get a feel for Markdown's formatting syntax is simply
|
34
|
+
to look at a Markdown-formatted document. For example, you can view
|
35
|
+
the Markdown source for the article text on this page here:
|
36
|
+
<http://daringfireball.net/projects/markdown/index.text>
|
37
|
+
|
38
|
+
(You can use this '.text' suffix trick to view the Markdown source for
|
39
|
+
the content of each of the pages in this section, e.g. the
|
40
|
+
[Syntax][s_src] and [License][l_src] pages.)
|
41
|
+
|
42
|
+
[s_src]: /projects/markdown/syntax.text
|
43
|
+
[l_src]: /projects/markdown/license.text
|
44
|
+
|
45
|
+
Markdown is free software, available under a BSD-style open source
|
46
|
+
license. See the [License] [pl] page for more information.
|
47
|
+
|
48
|
+
[pl]: /projects/markdown/license
|
49
|
+
|
50
|
+
|
51
|
+
Discussion List <a id="discussion-list" />
|
52
|
+
---------------
|
53
|
+
|
54
|
+
I've set up a public [mailing list for discussion about Markdown] [ml].
|
55
|
+
Any topic related to Markdown -- both its formatting syntax and
|
56
|
+
its software -- is fair game for discussion. Anyone who is interested
|
57
|
+
is welcome to join.
|
58
|
+
|
59
|
+
It's my hope that the mailing list will lead to good ideas for future
|
60
|
+
improvements to Markdown.
|
61
|
+
|
62
|
+
[ml]: http://six.pairlist.net/mailman/listinfo/markdown-discuss
|
63
|
+
|
64
|
+
|
65
|
+
Installation and Requirements <a id="install" />
|
66
|
+
-----------------------------
|
67
|
+
|
68
|
+
Markdown requires Perl 5.6.0 or later. Welcome to the 21st Century.
|
69
|
+
Markdown also requires the standard Perl library module [Digest::MD5]
|
70
|
+
[md5], which is probably already installed on your server.
|
71
|
+
|
72
|
+
[md5]: http://search.cpan.org/dist/Digest-MD5/MD5.pm
|
73
|
+
|
74
|
+
|
75
|
+
### Movable Type ###
|
76
|
+
|
77
|
+
Markdown works with Movable Type version 2.6 or later (including
|
78
|
+
Movable Type 3.0).
|
79
|
+
|
80
|
+
1. Copy the "Markdown.pl" file into your Movable Type "plugins"
|
81
|
+
directory. The "plugins" directory should be in the same directory
|
82
|
+
as "mt.cgi"; if the "plugins" directory doesn't already exist, use
|
83
|
+
your FTP program to create it. Your installation should look like
|
84
|
+
this:
|
85
|
+
|
86
|
+
(mt home)/plugins/Markdown.pl
|
87
|
+
|
88
|
+
2. Once installed, Markdown will appear as an option in Movable Type's
|
89
|
+
Text Formatting pop-up menu. This is selectable on a per-post basis:
|
90
|
+
|
91
|
+
![Screenshot of Movable Type 'Text Formatting' Menu][tfmenu]
|
92
|
+
|
93
|
+
Markdown translates your posts to HTML when you publish; the posts
|
94
|
+
themselves are stored in your MT database in Markdown format.
|
95
|
+
|
96
|
+
3. If you also install SmartyPants 1.5 (or later), Markdown will
|
97
|
+
offer a second text formatting option: "Markdown With
|
98
|
+
SmartyPants". This option is the same as the regular "Markdown"
|
99
|
+
formatter, except that it automatically uses SmartyPants to create
|
100
|
+
typographically correct curly quotes, em-dashes, and ellipses. See
|
101
|
+
the [SmartyPants web page][sp] for more information.
|
102
|
+
|
103
|
+
4. To make Markdown (or "Markdown With SmartyPants") your default
|
104
|
+
text formatting option for new posts, go to Weblog Config:
|
105
|
+
Preferences.
|
106
|
+
|
107
|
+
Note that by default, Markdown produces XHTML output. To configure
|
108
|
+
Markdown to produce HTML 4 output, see "Configuration", below.
|
109
|
+
|
110
|
+
[sp]: http://daringfireball.net/projects/smartypants/
|
111
|
+
|
112
|
+
|
113
|
+
|
114
|
+
### Blosxom ###
|
115
|
+
|
116
|
+
Markdown works with Blosxom version 2.0 or later.
|
117
|
+
|
118
|
+
1. Rename the "Markdown.pl" plug-in to "Markdown" (case is
|
119
|
+
important). Movable Type requires plug-ins to have a ".pl"
|
120
|
+
extension; Blosxom forbids it.
|
121
|
+
|
122
|
+
2. Copy the "Markdown" plug-in file to your Blosxom plug-ins folder.
|
123
|
+
If you're not sure where your Blosxom plug-ins folder is, see the
|
124
|
+
Blosxom documentation for information.
|
125
|
+
|
126
|
+
3. That's it. The entries in your weblog will now automatically be
|
127
|
+
processed by Markdown.
|
128
|
+
|
129
|
+
4. If you'd like to apply Markdown formatting only to certain
|
130
|
+
posts, rather than all of them, Markdown can optionally be used in
|
131
|
+
conjunction with Blosxom's [Meta][] plug-in. First, install the
|
132
|
+
Meta plug-in. Next, open the Markdown plug-in file in a text
|
133
|
+
editor, and set the configuration variable `$g_blosxom_use_meta`
|
134
|
+
to 1. Then, simply include a "`meta-markup: Markdown`" header line
|
135
|
+
at the top of each post you compose using Markdown.
|
136
|
+
|
137
|
+
[meta]: http://www.blosxom.com/plugins/meta/meta.htm
|
138
|
+
|
139
|
+
|
140
|
+
### BBEdit ###
|
141
|
+
|
142
|
+
Markdown works with BBEdit 6.1 or later on Mac OS X. It also works
|
143
|
+
with BBEdit 5.1 or later and MacPerl 5.6.1 on Mac OS 8.6 or later. If
|
144
|
+
you're running Mac OS X 10.2 (Jaguar), you may need to install the
|
145
|
+
Perl module [Digest::MD5] [md5] from CPAN; Digest::MD5 comes
|
146
|
+
pre-installed on Mac OS X 10.3 (Panther).
|
147
|
+
|
148
|
+
1. Copy the "Markdown.pl" file to appropriate filters folder in your
|
149
|
+
"BBEdit Support" folder. On Mac OS X, this should be:
|
150
|
+
|
151
|
+
BBEdit Support/Unix Support/Unix Filters/
|
152
|
+
|
153
|
+
See the BBEdit documentation for more details on the location of
|
154
|
+
these folders.
|
155
|
+
|
156
|
+
You can rename "Markdown.pl" to whatever you wish.
|
157
|
+
|
158
|
+
2. That's it. To use Markdown, select some text in a BBEdit document,
|
159
|
+
then choose Markdown from the Filters sub-menu in the "#!" menu, or
|
160
|
+
the Filters floating palette
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
Configuration <a id="configuration"></a>
|
165
|
+
-------------
|
166
|
+
|
167
|
+
By default, Markdown produces XHTML output for tags with empty elements.
|
168
|
+
E.g.:
|
169
|
+
|
170
|
+
<br />
|
171
|
+
|
172
|
+
Markdown can be configured to produce HTML-style tags; e.g.:
|
173
|
+
|
174
|
+
<br>
|
175
|
+
|
176
|
+
|
177
|
+
### Movable Type ###
|
178
|
+
|
179
|
+
You need to use a special `MTMarkdownOptions` container tag in each
|
180
|
+
Movable Type template where you want HTML 4-style output:
|
181
|
+
|
182
|
+
<MTMarkdownOptions output='html4'>
|
183
|
+
... put your entry content here ...
|
184
|
+
</MTMarkdownOptions>
|
185
|
+
|
186
|
+
The easiest way to use MTMarkdownOptions is probably to put the
|
187
|
+
opening tag right after your `<body>` tag, and the closing tag right
|
188
|
+
before `</body>`.
|
189
|
+
|
190
|
+
To suppress Markdown processing in a particular template, i.e. to
|
191
|
+
publish the raw Markdown-formatted text without translation into
|
192
|
+
(X)HTML, set the `output` attribute to 'raw':
|
193
|
+
|
194
|
+
<MTMarkdownOptions output='raw'>
|
195
|
+
... put your entry content here ...
|
196
|
+
</MTMarkdownOptions>
|
197
|
+
|
198
|
+
|
199
|
+
### Command-Line ###
|
200
|
+
|
201
|
+
Use the `--html4tags` command-line switch to produce HTML output from a
|
202
|
+
Unix-style command line. E.g.:
|
203
|
+
|
204
|
+
% perl Markdown.pl --html4tags foo.text
|
205
|
+
|
206
|
+
Type `perldoc Markdown.pl`, or read the POD documentation within the
|
207
|
+
Markdown.pl source code for more information.
|
208
|
+
|
209
|
+
|
210
|
+
Acknowledgements <a id="acknowledgements" />
|
211
|
+
----------------
|
212
|
+
|
213
|
+
[Aaron Swartz][] deserves a tremendous amount of credit for his feedback on the
|
214
|
+
design of Markdown's formatting syntax. Markdown is *much* better thanks
|
215
|
+
to Aaron's ideas, feedback, and testing. Also, Aaron's [html2text][]
|
216
|
+
is a very handy (and free) utility for turning HTML into
|
217
|
+
Markdown-formatted plain text.
|
218
|
+
|
219
|
+
[Nathaniel Irons][], [Dan Benjamin][], [Daniel Bogan][], and [Jason Perkins][]
|
220
|
+
also deserve thanks for their feedback.
|
221
|
+
|
222
|
+
[Michel Fortin][] has ported Markdown to PHP; it's a splendid port, and highly recommended for anyone looking for a PHP implementation of Markdown.
|
223
|
+
|
224
|
+
[Aaron Swartz]: http://www.aaronsw.com/
|
225
|
+
[Nathaniel Irons]: http://bumppo.net/
|
226
|
+
[Dan Benjamin]: http://hivelogic.com/
|
227
|
+
[Daniel Bogan]: http://waferbaby.com/
|
228
|
+
[Jason Perkins]: http://pressedpants.com/
|
229
|
+
[Michel Fortin]: http://www.michelf.com/projects/php-markdown/
|
230
|
+
[html2text]: http://www.aaronsw.com/2002/html2text/
|
231
|
+
|
232
|
+
[tfmenu]: /graphics/markdown/mt_textformat_menu.png
|