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

[backport, staging-20.09] asciidoctor: add revealjs support #107246

Closed

Conversation

bjornfor
Copy link
Contributor

Motivation for this change

This allows creating HTML presentations with
asciidoctor-revealjs presentation.adoc.

NOTE: The generated HTML file implicitly depend on reveal.js (and I see
no good way to bundle it with Nix). Either provide reveal.js in a local
path next to the generated HTML file[1], or override the revealjsdir
attribute, for example by pointing to an URL (can also be a path):

asciidoctor-revealjs -a revealjsdir=https://cdn.jsdelivr.net/npm/reveal.js@3.9.2 presentation.adoc

Implementation details:

  1. Added "gem 'asciidoctor-revealjs'" to the Gemfile.
  2. Ran "nix-shell -p bundler --run 'bundle lock --update'"
    from pkgs/tools/typesetting/asciidoctor/.
  3. Hand edited Gemfile.lock to remove all but the asciidoctor-revealjs
    changes. (Rationale: allow backporting to release-20.09.)
  4. Finish off with "nix-shell -p bundix --run 'bundix'".

[1] Of course Nix can help with that, but that's external to the
asciidoctor-revealjs program.

(cherry picked from commit 8f13d3c)

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after) Result: 323.0M -> 329.6M.
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

This allows creating HTML presentations with
`asciidoctor-revealjs presentation.adoc`.

NOTE: The generated HTML file implicitly depend on reveal.js (and I see
no good way to bundle it with Nix). Either provide reveal.js in a local
path next to the generated HTML file[1], or override the revealjsdir
attribute, for example by pointing to an URL (can also be a path):

  asciidoctor-revealjs -a revealjsdir=https://cdn.jsdelivr.net/npm/reveal.js@3.9.2 presentation.adoc

Implementation details:
1. Added "gem 'asciidoctor-revealjs'" to the Gemfile.
2. Ran "nix-shell -p bundler --run 'bundle lock --update'"
   from pkgs/tools/typesetting/asciidoctor/.
3. Hand edited Gemfile.lock to remove all but the asciidoctor-revealjs
   changes. (Rationale: allow backporting to release-20.09.)
4. Finish off with "nix-shell -p bundix --run 'bundix'".

[1] Of course Nix can help with _that_, but that's external to the
asciidoctor-revealjs program.

(cherry picked from commit 8f13d3c)
@vcunat
Copy link
Member

vcunat commented Dec 29, 2020

Already in there as 79c739c.

@vcunat vcunat closed this Dec 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants