HACKING.adoc in asciidoctor-revealjs-3.0.0 vs HACKING.adoc in asciidoctor-revealjs-3.1.0
- old
+ new
@@ -272,11 +272,20 @@
See https://github.com/asciidoctor/asciidoctor-reveal.js/issues/187#issuecomment-570771473[this issue] for background details on that topic.
Asciidoctor.js versioning policy is https://asciidoctor-docs.netlify.com/asciidoctor.js/project/version-and-lifecycle-policies/[available here].
+=== Debugging
+To debug the JavaScript application, just add `--node-arg=--inspect-brk` to the npx command to run the application.
+For example:
+
+ npx --node-arg=--inspect-brk asciidoctor-revealjs -v presentation.adoc
+
+Then open the Chrome Dev Tools and click on the Node logo in the top left corner.
+
+
== RubyGem package
[[ruby-localversion]]
=== Test a local asciidoctor-revealjs version
@@ -332,11 +341,14 @@
** Useful vim regex for AsciiDoc to Markdown:
+
:%s/{uri-issue}\(\d\+\)\[#\d\+]/#\1/gc
:%s/{project-name}/asciidoctor-reveal.js/gc
:%s/\(.*\)::/### \1/gc
+ :%s/{uri-repo}/https:\/\/github.com\/asciidoctor\/asciidoctor-reveal.js/gc
+** Save as draft
+
. Pushing the gem on rubygems.org:
+
$ bundle exec rake build
$ gem build asciidoctor-revealjs.gemspec
$ gem push asciidoctor-revealjs-X.Y.Z.gem
@@ -350,10 +362,16 @@
+
$ npm login # only required if not already authenticated
$ npm publish
. Check that the new version is available on https://www.npmjs.com/package/@asciidoctor/reveal.js[npmjs.com]
+. Make binaries release
+** Run `npm run package`. Binaries built will be in `dist/`. Upload them to the GitHub release page.
. Update version in `lib/asciidoctor-revealjs/version.rb` and `package.json` (+1 bugfix and append '-dev') and commit
+** Remove the "Slim compiled to Ruby" converter to the git tree (to avoid noise to the repo and `git status` noise)
++
+ git rm --cached lib/asciidoctor-revealjs/converter.rb
+
** commit msg: Begin development on next release
. Submit a PR upstream to sync the documentation on asciidoctor.org
** Modify this page: https://github.com/asciidoctor/asciidoctor.org/edit/master/docs/asciidoctor-revealjs.adoc
== Ruby and asciidoctor-doctest tests