Merge pull request #322 from obilodeau/debugging-fixes

Changes required to make debugging work again

CHANGELOG.adoc

@@ -11,10 +11,14 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 
 Enhancements::
   * Built-in slim templates can now be overridden with `--template-dir` or `-T` ({uri-issue}177[#177], {uri-issue}318[#318])
+  * Documentation improvements ({uri-issue}322[#322])
 
 Compliance::
   * Added support for the `sectnums` AsciiDoc attribute ({uri-issue}185[#185], {uri-issue}317[#317])
 
+Bug Fixes::
+  * Interactive debugging works again ({uri-issue}322[#322])
+
 
 == 3.1.0 (2020-01-18)
 

HACKING.adoc

@@ -30,9 +30,8 @@ Two complementary approaches can be used to explore the context offered by ascii
 
 [NOTE]
 --
-Starting with v1.1.0 the slim templates are compiled to Ruby in order to
-use the same templates from Asciidoctor.js (Javascript / Node.js ecosystem).
-Don't forget to recompile the templates if you make changes to them.
+Debugging is only supported via the Ruby ecosystem.
+You need to recompile the templates when you make changes to them.
 This can be done by running:
 
     bundle exec rake build
@@ -80,6 +79,10 @@ In order to be dropped into the debugger at a specific point in a template simpl
 - binding.pry
 ----
 
+Recompile the templates with:
+
+    bundle exec rake build
+
 Then run `asciidoctor-revealjs` from the command-line to generate your document and you'll be dropped in the debugger:
 
 ----
@@ -111,13 +114,11 @@ You can also query asciidoctor's documentation:
 If you install the `pry-byebug` gem you get additional debugging capabilities.
 See the gem's documentation for details.
 
-Since 1.1.0, templates are compiled. It is easier to inject the debug
-triggering statements and use the templates directly instead of debugging
-compiled templates. You can call the slim templates directly with:
-
-// TODO it's still not clear whether `-r slim-htag` is required right now (#153)
+Since 1.1.0, templates are compiled.
+It is easier to inject the debug triggering statements and use the templates directly instead of debugging compiled templates.
+You can call the slim templates directly with:
 
-    bundle exec asciidoctor --trace -T templates/ examples/customcss.adoc
+    bundle exec asciidoctor-revealjs --trace -T templates/ examples/customcss.adoc
 
 === References
 

asciidoctor-revealjs.gemspec

@@ -37,8 +37,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 13.0.0'
   s.add_development_dependency 'asciidoctor-doctest', '= 2.0.0.beta.5'
   s.add_development_dependency 'minitest', '~> 5.14'
-  s.add_development_dependency 'pry', '~> 0.10.4'
   if RUBY_ENGINE != 'jruby'
+    s.add_development_dependency 'pry', '~> 0.12.0'
+    s.add_development_dependency 'irb'
     s.add_development_dependency 'pry-byebug'
     s.add_development_dependency 'pygments.rb'
   end