Commit 11f64e98 authored by Emmanuel Milou's avatar Emmanuel Milou
Browse files

Settle on adoc extension for asciidoc files

parent 6aa9364b
= Boilerplate template for Drupal projects
= SFLinux Drupal Boilerplate
SFL Drupal Team <drupal@lists.savoirfairelinux.net>
v2.0, 2016-03-10
:keywords: Drupal, SFL, SFLinux, AsciiDoc, Asciidoctor
......@@ -29,7 +29,7 @@ endif::[]
:doc-docker-baseimage: https://gitlab.savoirfairelinux.com/drupal/docker-lampd/
:doc-drush: http://docs.drush.org/en/master/
:gitlab-sflinux: https://gitlab.savoirfairelinux.com/drupal/sflinux
:doc-asciidoctor: http://asciidoctor.org/docs/asciidoc-recommended-practices/
image::http://test.savoirfairelinux.com/buildStatus/icon?job=drupal-sfl-boilerplate[Build status]
__________ _____ ____ ___ __ ____
......@@ -41,12 +41,11 @@ image::http://test.savoirfairelinux.com/buildStatus/icon?job=drupal-sfl-boilerpl
// (to make a title: echo " CLIENT.PROJECT" | figlet -f smslant )
This *generic template* aims at _implementating_ a default project tree, that then could be used as a *starter kit* for new Drupal projects.
It uses our custom Drupal distribution {gitlab-sflinux}[*SFLinux*] as codebase.
TIP: More information on our Drupal practices at Savoir-faire Linux are described in {sfl-wiki-drupal}[the official Wiki].
== System Requirements
This installation profile has been designed to work with Drupal 7, and is compatible with PHP > 5.3.
......@@ -94,22 +93,21 @@ More on Drush and Makefile: https://www.drupal.org/node/1432374.
== About this document
This document uses the Asciidoc syntax generator. It is a convenient
tool allowing to write documentation in raw text files, and convert
them to HTML or PDF later on.
This document uses the Asciidoc syntax generator.
It is a convenient tool allowing to write documentation in raw text files, and convert them to HTML or PDF later on.
Visit https://github.com/asciidoctor[Asciidoctor @ *GitHub*] for more informations.
The {doc-asciidoctor}[AsciiDoc Recommanded Practices] is also recommanded.
To generate a HTML version, first install asciidoctor package on your
Linux distribution, then issue following command:
To generate a HTML version, first install asciidoctor package on your Linux distribution, then issue following command:
$ asciidoctor README
$ asciidoctor README.adoc
The README.html is generated in the current directory.
Asciidoctor provides a native PDF renderer for Asciidoc. Still in alpha, but worth the try. Please follow the instructions on the official documentation to
install it, then issue following command:
$ asciidoctor-pdf README
$ asciidoctor-pdf README.adoc
The README.pdf file shall be created in the current directory.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment