calico 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.md +21 -1
- data/lib/calico.rb +1 -0
- metadata +1 -1
data/README.md
CHANGED
@@ -1,3 +1,23 @@
|
|
1
|
-
|
1
|
+
Calico
|
2
|
+
======
|
2
3
|
|
4
|
+
Calico is a lightweight markup language designed to be used in web apps to
|
5
|
+
format user-submitted content.\\
|
6
|
+
It mainly uses Markdown's syntax when appropriated to make things painless.
|
3
7
|
|
8
|
+
It is greatly inspired by [Challis](http://github.com/chneukirchen/challis) from
|
9
|
+
Christian Neukirchen, but is even more lightweight.
|
10
|
+
|
11
|
+
## Features
|
12
|
+
|
13
|
+
Calico handles four block elements: paragraphs, (unordered) lists, quotes and
|
14
|
+
raw unprocessed text blocks.
|
15
|
+
|
16
|
+
In the first three block types, you can use inline markup along the lines of
|
17
|
+
Markdown. Raw blocks are left untouched (except HTML-entity escaping)
|
18
|
+
|
19
|
+
## Tutorial
|
20
|
+
|
21
|
+
Blocks are separated by two newlines. Raw blocks are enclosed by a pair of `---`
|
22
|
+
on their own lines. The first characters of a block gives it's type: `*␣` for a
|
23
|
+
list, `>␣` for a quote, anything else for a paragraph.
|
data/lib/calico.rb
CHANGED