https://github.com/unidata/unidata-jekyll-gradle

A gradle plugin for building Jekyll sites using the Unidata Jekyll Theme
https://github.com/unidata/unidata-jekyll-gradle

Last synced: 10 months ago
JSON representation

A gradle plugin for building Jekyll sites using the Unidata Jekyll Theme

• Host: GitHub
• URL: https://github.com/unidata/unidata-jekyll-gradle
• Owner: Unidata
• License: bsd-3-clause
• Created: 2020-12-31T03:47:28.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2021-06-22T21:01:27.000Z (over 4 years ago)
• Last Synced: 2025-01-12T15:46:20.264Z (12 months ago)
• Language: Groovy
• Size: 113 KB
• Stars: 0
• Watchers: 5
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Unidata Jekyll Plugin for Gradle

This repository manages a gradle plugin that allows projects at the Unidata Program Center to build Jekyll based sites using the [Unidata Jekyll theme](https://github.com/Unidata/unidata-jekyll-theme).

When applied to a gradle project, the plugin sets up one configuration and creates two tasks.

The plugin also adds any necessary repositories and dependencies.

## Adding the plugin

Adding the plugin to a gradle project is a two-step process.

First, you will need tell gradle where it can find the plugin.

This can be done by adding the following to your projects `settings.gradle` file:

~~~

pluginManagement {

  repositories {

    gradlePluginPortal()

    // limits the use of the unidata repository to the unidata jekyll plugin

    exclusiveContent {

      forRepository {

        maven {

          url "https://artifacts.unidata.ucar.edu/repository/unidata-all/"

        }

      }

      filter {

        includeModule 'edu.ucar.unidata.site.jekyll', 'edu.ucar.unidata.site.jekyll.gradle.plugin'

      }

    }

  }

}

~~~

Second, you will need to apply the plugin to your gradle project by adding the following to the project `build.gradle` file:

~~~

plugins {

  id 'edu.ucar.unidata.site.jekyll' version ''

}

~~~

## Configuration

The plugin has two settings that can be configured: the location of the Jekyll source directory, and the location of the Jekyll output directory.

These locations are configurable using the `unidataJekyll` configuration (default values shown):

~~~

unidataJekyll {

  sourceDirectory = file('src/site')

  destinationDirectory = file('build/site')

}

~~~

## Tasks

When the plugin is applied to a project, two tasks become available - `buildJekyllSite` and `serveJekyllSite`.

The `buildJekyllSite` will read the Jekyll configuration and source markdown files from the `sourceDirectory`, and will generate a static HTML site using the Unidata Jekyll Theme in the `destinationDirectory`.

The `serveJekyllSite` is similar to `buildJekyllSite`, with two additional feature.

First, `serverJekyllSite` will spin up a local webserver that can be used to view the generated HTML.

Second, the tasks will watch the `sourceDirectory` for changes, and will regenerate the HTML when any changes to the source markdown files are made.

Together, this allows you to live edit the content of your Jekyll site.