2016-11-07

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.

Installation of asciidoctor_to_rss

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

Howto write news

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

Configuration

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 .

Run the utility

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.