Skip to content

edc4it/reveal.js-external-code

Folders and files

NameName
Last commit message
Last commit date
Apr 11, 2024
Apr 2, 2024
Apr 2, 2024
Apr 2, 2024
Apr 2, 2024
Apr 2, 2024
Apr 2, 2024
Apr 2, 2024
Apr 2, 2024
Apr 2, 2024
Apr 2, 2024
Apr 2, 2024
Apr 2, 2024
Apr 2, 2024
Apr 2, 2024
Aug 26, 2024
Apr 2, 2024
Apr 2, 2024
Apr 2, 2024
Aug 29, 2024

Repository files navigation

Reveal.js External Code

Version

A reveal.js plugin to load code from the server. This is helpful when code samples/demos are part of your reveal.js presentation. This way your demos and slides stay in sync.

You will need to run your slides from a server.

Quickstart

Installation

This plugin is published to, and can be installed from, npm.

npm install add @edc4it/reveal.js-external-code

Or using yarn

yarn add @edc4it/reveal.js-external-code

Initialise (as npm library)

import Reveal from 'reveal.js';
import RevealHighlight from 'reveal.js/plugin/highlight/highlight';
import ExternalCode from '@edc4it/reveal.js-external-code';

Reveal.initialize({
  externalCode: {},
  plugins: [ExternalCode, RevealHighlight], // makes sure this plugin preceeds Hljs
});

Add an external code block

Instead of adding pre > code, you add an object[type="reveal.js/code"]. This object element will be replaced by a wrapper div.external-code-wrapper containing pre > code. You can use any of the data-* attributes used by reveal.js (see docs); below we are adding data-line-numbers. In fact all attributes will be added to the pre > code element (except its class attribute, see below).

<object type="reveal.js/code" data-src="code-samples/k8s.yaml" data-line-numbers="1">
</object>

Any known fragments classes on the object are applied to the div.external-code-wrapper element.

<object class="fragment" type="reveal.js/code" data-src="code-samples/k8s.yaml" data-line-numbers="1">
</object>

Limit lines

By default, all lines in the data-src are displayed (except the one with an optional @reveal.js/code annotation, see below). You can define a range to limit only certain lines. Skipped lines are shown using an ellipsis: "…" (Unicode Character U+2026)

Syntax

The range is a comma-separate list of:

  • single line number: n
  • line range start-end

Examples:

  • 1
  • 1, 5
  • 1-2, 3
  • 1-2, 3, 7-9

This range can be set on two levels, in order of precedence:

  1. inside the file
  2. on the object[type="reveal.js/code"] using the data-lines attributes

Inside the file:

On the first line of the file add a @reveal.js/code "annotation" (most likely you'll use your code's syntax for a comment as below -- for Haskel)

-- @reveal.js/code 
fib :: Int -> Int
fib 0 = 0
fib 1 = 1
fib n = fib (n - 1) + fib (n - 2)

This line is stripped from the resulting code block. By itself, this annotation might be helpful to remind yourself that this file is used on slides. It can also include a range:

-- @reveal.js/code lines=2-4 
fib :: Int -> Int
fib 0 = 0
fib 1 = 1
fib n = fib (n - 1) + fib (n - 2)

using teh data-lines attribute

Below is an example using

<object type="reveal.js/code"
        data-src="code-samples/k8s.yaml"
        data-lines="1"
>

Global options

Reveal.initialize({
  externalCode: {
    basePath: "/",
    enableNotify: true,
    local: {
      absPath: "/home/rparree/projects/foss-edc4it/reveal.js-external-code/public",
      scheme: 'vscode://file//', // default
    },
    codeBlock: {
      trim: true,
      additionalClasses: ["stretch"]
    }
    

  },
  plugins: [ExternalCode, RevealHighlight],
})
  • basePath: path prefix for fetching remote content (/)
  • enableNotify: enable "toaster" error notification using simple-notify for when the file cannot be loaded (true)
  • local: configures local copy on the presenter's machine
    • scheme: ('vscode://file//')
    • absPath: the full path on the local machine (you probably want to use a cookie value for this, so it can be changed)
  • codeBlock
    • trim: set to false to keep whitespace before first character/after last character
    • additionalClasses: array of additional css classes to add to the code element