Code Monkey home page Code Monkey logo

gradlesite's Introduction

Gradle Site Plugin

This plugin generates project websites as known from the Maven Site plugin does. The supported file types are:

  • APT
  • XDOC

This plugin was originally written for a live demo at the GR8conf 2011 in Europe.

At the moment this plugin is just a kind of a wrapper for the mvn site generation as some projects reported, that the missing gradle site support is a blocker for them.

I've tested this plugin with the codenarc project. Please provide me links to other projects to test it with.

Later this plugin should move from a plain wrapper to a first class website generation of gradle (multi)project builds.

TASKS

  • site - generates the project website to $buildDir/site
  • siteClean - cleans up the site target directory

Example usage:

buildscript { 
    repositories { 
		mavenCentral()
		mavenLocal()
	} 
    dependencies {
        classpath 'com.breskeby:GradleSite:0.1-SNAPSHOT'
    } 
}

apply plugin:'groovy'
apply plugin:'Site'

sourceCompatibility = 1.5
targetCompatibility = 1.5

repositories {
    mavenCentral()
}

deployDir = "build/customDir" as File // change the site output directory

site{
	html.title = "Welcome at Codenarc" //set a custom browser title
}

TODO

  • cleanup extensive and not used transitive doxia dependencies
  • cleanup default css
  • allow custom css definitions
  • support FML file types
  • deploy tasks
  • add more documentation than this readme
  • deploy this to a public repository

Known Issues

  • tests with the codenarc project shows following error/warn messages:

      	[warn] [APT Parser] Ambiguous link: 'codenarc-rules-serialization.html'. 			
      	If this is a local link, prepend "./"!
    

Support this

  • fork it
  • Flattr this git repo

gradlesite's People

Contributors

breskeby avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.