From 5ef4fc9cf123f6acaac7cf461989b502e8006d7c Mon Sep 17 00:00:00 2001 From: Olivier Bilodeau Date: Sun, 24 Dec 2017 13:52:41 -0500 Subject: [PATCH] README points to stable branches of interest (fixes #158) --- CHANGELOG.adoc | 2 +- README.adoc | 11 +++++++++-- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index 2100c998..bae53a58 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -13,7 +13,7 @@ Enhancements:: * Support for Asciidoctor.js 1.5.6-preview.4 ({uri-issue}130[#130], {uri-issue}143[#143], {uri-issue}156[#156]) * Compiling slim templates to Ruby allows us to drop Jade templates for Asciidoctor.js users ({uri-issue}63[#63], {uri-issue}131[#131]) - * Documentation polish ({uri-issue}153[#153] and more) + * Documentation polish ({uri-issue}153[#153], {uri-issue}158[#158] and more) Compliance:: * Users of Asciidoctor (Ruby) and Asciidoctor.js (Javascript) now run the same set of templates meaning that we achieved feature parity between the two implementations diff --git a/README.adoc b/README.adoc index de3bf902..d902ae22 100644 --- a/README.adoc +++ b/README.adoc @@ -5,6 +5,7 @@ ifdef::env-github,env-browser[] :toclevels: 2 endif::[] ifdef::env-github[] +:branch: master :status: :outfilesuffix: .adoc :!toc-title: @@ -38,6 +39,14 @@ There are two main technology stacks that can transform AsciiDoc into HTML5 / re Right now the Asciidoctor / Ruby stack is the better tested one but with the changes in v1.1.0 they have feature parity. +ifeval::['{branch}' == 'master'] +NOTE: You're viewing the documentation for the upcoming release. +If you're looking for the documentation for an older release, please refer to one of the following branches: + +{uri-project-repo}/tree/maint-1.0.x#readme[1.0.x] +⁃ +{uri-project-repo}/tree/reveal.js-2.x#readme[Unversioned pre-release] (compatible with RevealJS 2.x) +endif::[] + == Ruby Setup @@ -48,8 +57,6 @@ For a quick start clone our https://github.com/obilodeau/presentation-revealjs-s For more complete instructions, read on. -NOTE: If you want to use reveal.js 2, please clone the asciidoctor-reveal.js repo and switch to the reveal.js-2.x branch. - === Prerequisites