https://github.com/m2ci-msp/gradle-pandoc-reveal-plugin

Apply common build logic to a slideshow project using Pandoc and reveal.js
https://github.com/m2ci-msp/gradle-pandoc-reveal-plugin

gradle-plugin pandoc reveal-js

Last synced: about 1 month ago
JSON representation

Apply common build logic to a slideshow project using Pandoc and reveal.js

• Host: GitHub
• URL: https://github.com/m2ci-msp/gradle-pandoc-reveal-plugin
• Owner: m2ci-msp
• License: apache-2.0
• Created: 2017-07-11T14:00:00.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-08-24T08:06:17.000Z (4 months ago)
• Last Synced: 2024-08-25T08:55:26.645Z (4 months ago)
• Topics: gradle-plugin, pandoc, reveal-js
• Language: Groovy
• Homepage:
• Size: 497 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![CI](https://github.com/m2ci-msp/gradle-pandoc-reveal-plugin/actions/workflows/main.yml/badge.svg)](https://github.com/m2ci-msp/gradle-pandoc-reveal-plugin/actions/workflows/main.yml)

[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)

Gradle Pandoc reveal.js plugin

==============================

[Gradle] plugin to apply common build logic to a slideshow project.

Compilation from Markdown to HTML5 using [Pandoc] and [reveal.js].

Prerequisites

-------------

[Java] must be installed.

This plugin requires Gradle v6.2 or higher.

Usage

-----

See [here](https://plugins.gradle.org/plugin/org.m2ci.msp.pandocreveal) for usage instructions.

When applying the plugin, the `compileReveal` task must be configured with a valid markdown source file:

```gradle

compileReveal {

  markdownFile = file('src/source.md')

  // optionally, YAML header in separate file:

  headerFile = file('src/header.yaml')

  // optionally, additional assets:

  assetFiles = files('some/asset.txt', tasks.findByName('assetProducingTask')) +

    fileTree('src').include('assets/**')

  // optionally, enable ToC and maybe set depth (default: 1)

  tableOfContents = true

  tableOfContentsDepth = 2

  // note that the ToC title heading will be empty; set `toc-title` to the desired heading in the YAML header file...

  // optionally, filters and/or environment variables for Pandoc exec, e.g.,:

  pandocFilters = ['mermaid-filter']

  pandocEnvironment = ['MERMAID_FILTER_FORMAT': 'svg']

}

```

Note that Pandoc filters such as [mermaid-filter] must be installed separately.

The generated slideshow will be created in `compileReveal.destDir` (default: `layout.buildDirectory.dir('slides')`)

[Gradle]: https://gradle.org

[Pandoc]: https://pandoc.org/

[reveal.js]: https://revealjs.com/

[Java]: https://www.java.com/

[mermaid-filter]: https://github.com/raghur/mermaid-filter