From: Jean-Philippe Orsini Date: Mon, 11 Jul 2016 18:36:50 +0000 (+0200) Subject: added news X-Git-Url: https://wpitchoune.net/gitweb/?p=www.git;a=commitdiff_plain;h=d76e170141a0523ee30feded9154c933dd447609 added news --- diff --git a/src/news/asciidoctor_to_rss.adoc b/src/news/asciidoctor_to_rss.adoc index b3b11bc..8fc8233 100644 --- a/src/news/asciidoctor_to_rss.adoc +++ b/src/news/asciidoctor_to_rss.adoc @@ -2,3 +2,70 @@ Jean-Philippe Orsini :date: 2016-11-07 :icons: font + +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`: 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. diff --git a/www/news/asciidoctor_to_rss.html b/www/news/asciidoctor_to_rss.html index 6378a86..2ef9441 100644 --- a/www/news/asciidoctor_to_rss.html +++ b/www/news/asciidoctor_to_rss.html @@ -10,5 +10,101 @@
-
2016-11-07
+
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:

+
+
+

OUT_DIR:

+
+
+

CFG_FILE:

+
+
+
\ No newline at end of file diff --git a/www/news/feed.xml b/www/news/feed.xml index 74c6d67..90183ef 100644 --- a/www/news/feed.xml +++ b/www/news/feed.xml @@ -7,7 +7,103 @@ Asciidoctor to RSS http://wpitchoune.net/news/asciidoctor_to_rss.html - + <div id="preamble"> +<div class="sectionbody"> +<div class="paragraph"> +<p>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.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_installation_of_asciidoctor_to_rss">Installation of asciidoctor_to_rss</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>It is required to install:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>maven</p> +</li> +<li> +<p>java (&gt;1.7)</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p>The sources can be retrieved from GIT:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>git clone git clone https://git.wpitchoune.net/asciidoctor_to_rss.git</pre> +</div> +</div> +<div class="paragraph"> +<p>Compilation:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>cd asciidoctor_to_rss +mvn clean install</pre> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_howto_write_news">Howto write news</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>Each news has to be written in a separate Asciidoctor document +and all documents must be dropped into a directory.</p> +</div> +<div class="paragraph"> +<p>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.</p> +</div> +<div class="paragraph"> +<p>You can see some examples at <a href="https://wpitchoune.net/gitweb/?p=www.git;a=tree;f=src/news;hb=HEAD" class="bare">https://wpitchoune.net/gitweb/?p=www.git;a=tree;f=src/news;hb=HEAD</a> . +The source document of this news is at <a href="https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/news/asciidoctor_to_rss.adoc;hb=HEAD" class="bare">https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/news/asciidoctor_to_rss.adoc;hb=HEAD</a></p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_configuration">Configuration</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>The configuration of the utility can be done in text file.</p> +</div> +<div class="paragraph"> +<p>See an example at <a href="https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/asciidoctorrss.props;hb=HEAD" class="bare">https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/asciidoctorrss.props;hb=HEAD</a> .</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_run_the_utility">Run the utility</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>The command line usage is:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre>asciidoctor_to_rss.sh &lt;IN_DIR&gt; &lt;OUT_DIR&gt; &lt;CFG_FILE&gt;</pre> +</div> +</div> +<div class="paragraph"> +<p><code>IN_DIR</code>:</p> +</div> +<div class="paragraph"> +<p><code>OUT_DIR</code>:</p> +</div> +<div class="paragraph"> +<p><code>CFG_FILE</code>:</p> +</div> +</div> +</div> Sun, 10 Jul 2016 22:00:00 GMT http://wpitchoune.net/news/asciidoctor_to_rss.html 2016-07-10T22:00:00Z diff --git a/www/news/news.html b/www/news/news.html index 5c0a642..5285000 100644 --- a/www/news/news.html +++ b/www/news/news.html @@ -11,7 +11,103 @@

News

- +

Asciidoctor to RSS

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:

+
+
+

OUT_DIR:

+
+
+

CFG_FILE:

+
+
+

RSS Feed

2016-04-07

It is now possible to follow news and announces of the