Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README points to stable branches of interest (fixes #158) #160

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 9 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ ifdef::env-github,env-browser[]
:toclevels: 2
endif::[]
ifdef::env-github[]
:branch: master
:status:
:outfilesuffix: .adoc
:!toc-title:
Expand Down Expand Up @@ -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

Expand All @@ -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

Expand Down