Gradle Site Plugin

Introduction

The Gradle Site Plugin provides helpful tools and shared configuration used to create and manage a project website and to aid with other project-related documentation.

Features

• Aggregates standard generated documentation and build reports for easy site inclusion.
• Provides tasks to manage the documented project version in the site and project README.
• Allows for verification of published content.
• Configures the `build/site` directory as the resource directory when the Web Preview Plugin is applied.

Installation

Build script snippet for use in all Gradle versions:

buildscript {
    repositories {
        maven {
            url "https://plugins.gradle.org/m2/"
        }
    }
    dependencies {
        classpath "gradle.plugin.com.stehno.gradle:site:0.0.3"
    }
}

apply plugin: "com.stehno.gradle.site"
    

Build script snippet for new, incubating, plugin mechanism introduced in Gradle 2.1:

plugins {
    id "com.stehno.gradle.site" version "0.0.3"
}
    

Usage

See the User Guide for configuration and usage information.