@karuga/slides v1.0.0

Slides

This is a transformer plugin for unified.js that creates HTML slides / presentations from markdown input.

Example

const fs = require("fs");

const unified = require("unified");
const remarkParse = require("remark-parse");
const remarkRehype = require("remark-rehype");
const rehypeRaw = require("rehype-raw");
const rehypeHighlight = require("rehype-highlight");
const rehypeInline = require("@karuga/rehype-inline");
const rehypeStringify = require("rehype-stringify");

const slides = require("@karuga/slides");

const input = `
# slide 1

content of slide 1

# slide 2

content of slide 2
`;

const pipeline = unified()
  .use(remarkParse) // parse markdown string
  .use(remarkRehype, { allowDangerousHTML: true }) // convert to HTML
  .use(rehypeRaw) // parse again to get inner HTML elements
  .use(slides, {
    format: "revealjs",
    slideSeparators: ["h1"]
  }) // convert to a reveal.js presentation
  .use(rehypeHighlight) // highlight code blocks
  .use(rehypeInline) // bundle into one file
  .use(rehypeStringify);

const htmlString = pipeline.processSync(input).toString();
fs.writeFileSync("slides.html", htmlString);

More demos

Run the demos via:

node demo/demo.js

This will read the markdown files and create new HTML files in the demo folder.

Formats

At the moment the main format that is supported is reveal.js presentations. Other formats will be added in the future.

Configuration options

example:

unified().use(slides, {
  format: "revealjs",
  sectionSeparators: ["h1"],
  slideSeparators: ["h2"]
});

• format: "revealjs" or "revealjs_karuga"; other formats may be supported in the future
• slideSeparators: array of HTML elements that separate slides; e.g.: ["h2", "hr"], default: []
• sectionSeparators: array of HTML elements that separate sections; e.g.: ["h1"], default: []