X-Git-Url: https://git.wpitchoune.net/gitweb/?a=blobdiff_plain;f=www%2Fnews%2Fasciidoctor_to_rss.html;h=3e78bca338702127c6d82d2dbfdca8f47b68630c;hb=5f3736670824aecdf2746004c0e2effbc58dfeed;hp=6378a863f973fb15ff783185198c8c3b6aba47d2;hpb=7ad4278575f413699b6d754ba7cf04cca9cd397c;p=www.git diff --git a/www/news/asciidoctor_to_rss.html b/www/news/asciidoctor_to_rss.html index 6378a86..3e78bca 100644 --- a/www/news/asciidoctor_to_rss.html +++ b/www/news/asciidoctor_to_rss.html @@ -1,14 +1,127 @@
- + - + +In order to have a website based only on Asciidoctor +documents, I have written a small utility which +converts a set of Asciidoctor documents to HTML pages and +generates a RSS 2.0 feed.
+It is required to install:
+maven
+java (>1.7)
+The sources can be retrieved from GIT:
+git clone git clone https://git.wpitchoune.net/asciidoctor_to_rss.git+
Compilation:
+cd asciidoctor_to_rss +mvn clean install+
Each news has to be written in a separate Asciidoctor document +and all documents must be dropped into a directory.
+There is not any restriction concerning the syntax because +the utility is based on the java bridge of Asciidoctor. +I have added an attribute 'date' which allows the utility +to know the publication date of the news.
+You can see some examples at https://wpitchoune.net/gitweb/?p=www.git;a=tree;f=src/news;hb=HEAD . +The source document of this news is at https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/news/asciidoctor_to_rss.adoc;hb=HEAD
+The configuration of the utility can be done in text file.
+See an example at https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/asciidoctorrss.props;hb=HEAD .
+The command line usage is:
+asciidoctor_to_rss.sh <IN_DIR> <OUT_DIR> <CFG_FILE>+
IN_DIR
: the directory containing the news as Asciidoctor documents.
OUT_DIR
: the output directory which contains all generated files
CFG_FILE
: the path to the configuration file
The OUT_DIR
will contain:
one HTML file for each Asciidoctor document
+the news.html
file
the feed.xml
file which is a feed compatible with RSS v2.0.