diff options
Diffstat (limited to 'man/blogc-source.7.ronn')
| -rw-r--r-- | man/blogc-source.7.ronn | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/man/blogc-source.7.ronn b/man/blogc-source.7.ronn index 7fa0796..b583d6e 100644 --- a/man/blogc-source.7.ronn +++ b/man/blogc-source.7.ronn @@ -45,6 +45,15 @@ You can omit seconds, minutes and hours if you want, they will be filled with The ``DATE_FORMAT`` variable should be passed to blogc(1) as a global variable. Its value must be a valid strptime(3) format. +The source parser will also automatically generate a variable called `FILENAME`, +that stores the name of the source file, without its extension. This is useful +for building permalinks in templates. This variable can't be overriden by an +explicit definition in source file. + +Another variable, `DESCRIPTION`, will be automatically created by the source +parser. Its content is the first line of the first paragraph of the content. +This variable can be overriden by an explicit definition in source file. + ## SOURCE CONTENT - BLOCK ELEMENTS ### Paragraphs @@ -203,18 +212,35 @@ Images are defined using the following syntax: This is an image:  +Whitespace characters and new lines are allowed between alt text and image URL: + + 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](https://blogc.rgm.io). +Whitespace characters and new lines are allowed between link text and link URL: + + To learn more about blogc, [click here] + (https://blogc.rgm.io). + ### Image Links Links can be combined with images: [](https://blogc.rgm.io) +Whitespace characters and new lines are allowed between link text and link URL, +and between alt text and image URL: + + [![This is the image alt text] + (picture.jpg)] + (https://blogc.rgm.io) + ### Automatic Links Automatic link is defined with 2 '[' before and 2 ']' after the URL. @@ -226,6 +252,11 @@ Automatic link is defined with 2 '[' before and 2 ']' after the URL. Line breaks can be added after a paragraph line adding 2 or more white spaces to the end of the line. +### En dashes and Em dashes + +Sequences of 2 '-' characters are converted to an En dash HTML entity. +Sequences of 3 '-' characters are converted to an Em dash HTML entity. + ## BUGS |