Asciidoctor to RSS

X-Git-Url: http://git.wpitchoune.net/gitweb/?p=www.git;a=blobdiff_plain;f=www%2Fnews%2Fasciidoctor_to_rss.html;h=ef2bfff873b0bb26cbc056a707d262c7f81c160f;hp=ffc4cd0a974ee4aba81d2495a6277e7da20aa4ac;hb=1587eac4e9940c095ae78a6758fb6344f3aed75d;hpb=2dd558f5533166a85045f581b042dd539505ecce diff --git a/www/news/asciidoctor_to_rss.html b/www/news/asciidoctor_to_rss.html index ffc4cd0..ef2bfff 100644 --- a/www/news/asciidoctor_to_rss.html +++ b/www/news/asciidoctor_to_rss.html @@ -1,10 +1,11 @@ - + - + +Asciidoctor to RSS

@@ -13,10 +14,14 @@

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.

In order to ease the edition of this website and +the management of the server, I want it to be purely +static and generated from Asciidoctor documents.

The news part of the website is also written as Asciidoctor +documents, asciidoctor_to_rss is converting them into static +HTML pages and generates a RSS 2.0 file.

@@ -29,10 +34,10 @@ generates a RSS 2.0 feed.

-
maven
+
Apache Maven (3.3.9)
-
java (>1.7)
+
Java (Sun JDK >=1.8)

@@ -59,18 +64,47 @@ mvn clean install

Howto write news

Each news has to be written in a separate Asciidoctor document +

Each news must be written in an 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 +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

Here is an example of news:

= Asciidoctor to RSS
+Jean-Philippe Orsini <jeanfi@gmail.com>
+:date: 2016-11-07
+:icons: font
+
+In order to ease the edition of this website and
+the management of the server, I want it to be purely
+static and generated from http://asciidoctor.org[Asciidoctor] documents.
+
+The _news_ part of the website is also written as Asciidoctor
+documents, `asciidoctor_to_rss` is converting them into static
+HTML pages and generates a RSS 2.0 file.
+
+== Installation of asciidoctor_to_rss
+
+It is required to install:
+
+* http://maven.apache.org/download.cgi[Apache Maven] (3.3.9)
+
+* http://www.oracle.com/technetwork/java/javase/downloads/index.html[Java] (Sun JDK >=1.8)

You can see few 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.

@@ -78,10 +112,37 @@ The source document of this news is at Configuration

The configuration of the utility can be done in text file.

The configuration file of asciidoctor_to_rss is text file containing key/value pairs.

See an example at +https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/asciidoctorrss.props;hb=HEAD .

feed.title=News
+feed.description=News of the wpitchoune.net website.
+feed.link=https://wpitchoune.net/news/feed.xml
+feed.baseurl=https://wpitchoune.net/news
+
+html.header.file=src/header.html

feed.title: the title used for the feed, in the RSS 2.0 and news.html files.

feed.description: the description used in the RSS 2.0 file.

feed.link: URI of the RSS 2.0 file.

feed.baseurl: base URI where the HTML news files will be located.

See an example at https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/asciidoctorrss.props;hb=HEAD .

html.header.file: the content of the denoted file will be added in the head block of +the generated HTML documents.

@@ -100,10 +161,10 @@ The source document of this news is at -

OUT_DIR: the output directory which contains all generated files

OUT_DIR: the output directory which contains all generated files.

CFG_FILE: the path to the configuration file

CFG_FILE: the path to the configuration file.

The OUT_DIR will contain:

@@ -111,16 +172,32 @@ The source document of this news is at

one HTML file for each Asciidoctor document

one HTML file for each Asciidoctor document,

-
the news.html file
+
the news.html file,
-
the feed.xml file which is a feed compatible with RSS v2.0.
+
and the feed.xml file which is a feed +compatible with RSS v2.0.

- + + \ No newline at end of file