From de334a9e32d0d1d19c4aa98415cfe35866686157 Mon Sep 17 00:00:00 2001 From: "Rafael G. Martins" Date: Sun, 21 Feb 2016 14:31:05 +0100 Subject: man: improved content-parser docs --- man/blogc-source.7.ronn | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'man/blogc-source.7.ronn') diff --git a/man/blogc-source.7.ronn b/man/blogc-source.7.ronn index 7fa0796..5a0a485 100644 --- a/man/blogc-source.7.ronn +++ b/man/blogc-source.7.ronn @@ -209,12 +209,22 @@ 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: [![This is the image alt text](picture.jpg)](https://blogc.rgm.io) +Whitespace characters and new lines are allowed 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. -- cgit v1.2.3-18-g5258 From 437ea5b71f7a1f6cd5d09b28259a8e49acab7fbc Mon Sep 17 00:00:00 2001 From: "Rafael G. Martins" Date: Sun, 21 Feb 2016 16:43:31 +0100 Subject: man: tests: minor documentation fix and more test coverage --- man/blogc-source.7.ronn | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'man/blogc-source.7.ronn') diff --git a/man/blogc-source.7.ronn b/man/blogc-source.7.ronn index 5a0a485..c2c0490 100644 --- a/man/blogc-source.7.ronn +++ b/man/blogc-source.7.ronn @@ -203,6 +203,11 @@ Images are defined using the following syntax: This is an image: ![This is the image alt text](picture.jpg) +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: @@ -220,10 +225,12 @@ Links can be combined with images: [![This is the image alt text](picture.jpg)](https://blogc.rgm.io) -Whitespace characters and new lines are allowed between alt text and image URL: +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) + (picture.jpg)] + (https://blogc.rgm.io) ### Automatic Links -- cgit v1.2.3-18-g5258 From 4c3533500058efaa2cabbe08f70e0b0a64ea3e37 Mon Sep 17 00:00:00 2001 From: "Rafael G. Martins" Date: Sat, 5 Mar 2016 19:46:52 +0100 Subject: man: added em/en-dashes --- man/blogc-source.7.ronn | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'man/blogc-source.7.ronn') diff --git a/man/blogc-source.7.ronn b/man/blogc-source.7.ronn index c2c0490..c49f3ce 100644 --- a/man/blogc-source.7.ronn +++ b/man/blogc-source.7.ronn @@ -243,6 +243,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 -- cgit v1.2.3-18-g5258 From 114b36f95116f62bfcf9d79e441ab81aed35454b Mon Sep 17 00:00:00 2001 From: "Rafael G. Martins" Date: Sat, 30 Apr 2016 02:41:00 +0200 Subject: man: added blogc-pagination(7) --- man/blogc-source.7.ronn | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'man/blogc-source.7.ronn') diff --git a/man/blogc-source.7.ronn b/man/blogc-source.7.ronn index c49f3ce..1a2cc76 100644 --- a/man/blogc-source.7.ronn +++ b/man/blogc-source.7.ronn @@ -45,6 +45,10 @@ 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. + ## SOURCE CONTENT - BLOCK ELEMENTS ### Paragraphs -- cgit v1.2.3-18-g5258 From 95b49cad4665bb958d2e1b8e8c8e25a74cffabce Mon Sep 17 00:00:00 2001 From: "Rafael G. Martins" Date: Sat, 30 Apr 2016 02:56:33 +0200 Subject: man: added documentation for DESCRIPTION variable --- man/blogc-source.7.ronn | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'man/blogc-source.7.ronn') diff --git a/man/blogc-source.7.ronn b/man/blogc-source.7.ronn index 1a2cc76..b583d6e 100644 --- a/man/blogc-source.7.ronn +++ b/man/blogc-source.7.ronn @@ -47,7 +47,12 @@ 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. +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 -- cgit v1.2.3-18-g5258