npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@edc4it/reveal.js-external-code

v1.0.4

Published

[![Version](https://img.shields.io/npm/v/@edc4it/reveal.js-external-code)](#)

Downloads

160

Readme

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