https://github.com/eskatos/jug-montpellier-gradle-best-practices

https://github.com/eskatos/jug-montpellier-gradle-best-practices

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/eskatos/jug-montpellier-gradle-best-practices
• Owner: eskatos
• Created: 2019-03-18T08:58:34.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-21T08:59:51.000Z (almost 6 years ago)
• Last Synced: 2024-11-01T20:06:38.591Z (3 months ago)
• Language: Kotlin
• Size: 7.33 MB
• Stars: 1
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Asciidoctor/Reveal.js presentation template

This is a template project for Asciidoctor+Reveal.js presentations.

To use it, just fork this repository and update the presentation as you wish.

## Configuration

Minimally, update the `build.gradle.kts` file to set your GitHub username:

```

presentation {

    githubUserName.set("yourUserName")

}

```

and change the name of the project in `settings.gradle.kts`:

```

rootProject.name = "my-awesome-presentation"

```

## Generating the presentation

Run:

```

./gradlew asciidoctor

```

## Uploading the slides on GitHub pages

Run:

```

./gradlew publishGhPages

```

If your repository name is different from the name of the project in `settings.gradle.kts`, update the configuration in `build.gradle.kts`:

```

presentation {

    githubUserName.set("yourUserName")

    githubRepoName.set("yourRepoName")

}

```

Then the presentation is going to be available at `https://yourUserName.github.io/yourRepoName/`

## Screencasts

This template supports screencasts in the [asciinema](https://asciinema.org/) format.

Include your JSON files in `src/docs/asciidoc/screencasts`, then include them in your presentation using:

```

screencast:my_file[]

```

## Exporting the presentation

This template supports exporting the presentation to PDF, JPEG and PNG.

You'll need a JDK which bundles JavaFX to do this.

Run this task:

```

./gradlew exportToPdf

```

to generate a PDF, or:

```

./gradlew export

```

to export to all formats.