aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRafael G. Martins <rafael@rafaelmartins.eng.br>2015-08-15 10:57:37 -0300
committerRafael G. Martins <rafael@rafaelmartins.eng.br>2015-08-15 10:57:37 -0300
commit8a965db8670b59074edd3f7f0fb0d638a00b0a08 (patch)
tree7f9b2cfc8a79ff6cec9ff86b44cd69dab4a92dbf
parentdbcfaf413330e71dbf329f9b07884b275221088c (diff)
downloadblogc-8a965db8670b59074edd3f7f0fb0d638a00b0a08.tar.gz
blogc-8a965db8670b59074edd3f7f0fb0d638a00b0a08.tar.bz2
blogc-8a965db8670b59074edd3f7f0fb0d638a00b0a08.zip
man: improved blogc-source(7)
-rw-r--r--man/blogc-source.7.ronn74
1 files changed, 73 insertions, 1 deletions
diff --git a/man/blogc-source.7.ronn b/man/blogc-source.7.ronn
index c48ce3b..2c710e5 100644
--- a/man/blogc-source.7.ronn
+++ b/man/blogc-source.7.ronn
@@ -78,6 +78,13 @@ the starting character must be preserved in the begin of each line.
* Second item
* Third item
+Multi-line items are supported. Content must be aligned properly:
+
+ * First item
+ Continuation of first item
+ * Second item
+ * Third item
+
### Ordered Lists
Ordered lists are defined with lines starting with a number and a '.' character.
@@ -89,6 +96,13 @@ value of the numbers is ignored.
2. Second item
10. Tenth item
+Multi-line items are supported. Content must be aligned properly:
+
+ 1. First item
+ Continuation of first item
+ 2. Second item
+ 10. Tenth item
+
To use numbers with '.' character in a non-list string, you must escape the '.'.
1234\. This is not a list
@@ -138,7 +152,65 @@ After parsing, the excerpt will be part of the full content as well.
## SOURCE CONTENT - INLINE ELEMENTS
-TODO
+### Bold
+
+Bold text is defined with 2 '*' or '_' before and after the text.
+
+ Bold text: **text**
+ Bold text: __text__
+
+### Italic
+
+Italic text is defined with 1 '*' or '_' before and after the text.
+
+ Italic text: *text*
+ Italic text: _text_
+
+### Bold and Italic
+
+Bold and italic text is defined mixing markers, like:
+
+ Italic and bold text: _**text**_
+ Italic and bold text: *__text__*
+ Italic and bold text: __*text*__
+ Italic and bold text: **_text_**
+
+### Code
+
+Code is defined with 1 or 2 '`' before and after the text.
+
+ This is inline code: `code`
+ This is inline code: ``code``
+
+### Images
+
+Images are defined using the following syntax:
+
+ This is an image: ![This is the image alt text](picture.jpg)
+
+### Links
+
+Links are defined using the following syntax:
+
+ To learn more about blogc, [click here](http://blogc.org).
+
+### Image Links
+
+Links can be combined with images:
+
+ [![This is the image alt text](picture.jpg)](http://blogc.org)
+
+### Automatic Links
+
+Automatic link is defined with 2 '[' before and 2 ']' after the URL.
+
+ To learn more about blogc, visit [[http://blogc.org]].
+
+### Line break
+
+Line breaks can be added after a paragraph line adding 2 or morewhite spaces
+to the end of the line.
+
## BUGS