Skip to content
This repository has been archived by the owner on Jan 3, 2019. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
Enable styling of site documentation
  • Loading branch information
Andrew Woods committed Jun 6, 2014
1 parent 85dcb8c commit 3e0e834
Show file tree
Hide file tree
Showing 3 changed files with 123 additions and 1 deletion.
67 changes: 66 additions & 1 deletion pom.xml
Expand Up @@ -43,7 +43,7 @@
</connection>
<developerConnection>scm:git:git@github.com:fcrepo4/${project_name}.git
</developerConnection>
<url>https://github.com/fcrepo4/${project_name}</url>
<url>https://github.com/fcrepo4/fcrepo-jms-indexer-pluggable</url>
<tag>HEAD</tag>
</scm>

Expand Down Expand Up @@ -278,6 +278,46 @@
</resources>
<pluginManagement>
<plugins>
<plugin>
<groupId>com.github.github</groupId>
<artifactId>site-maven-plugin</artifactId>
<version>0.9</version>
<configuration>
<message>Creating site for ${project.artifactId},
${project.version}</message>
<!-- this does the trick to place every module in the correct
subfolder -->
<path>${project.distributionManagement.site.url}</path>
<merge>true</merge>
</configuration>
<executions>
<execution>
<id>github</id>
<goals>
<goal>site</goal>
</goals>
<phase>site-deploy</phase>
</execution>
</executions>
</plugin>

<plugin>
<artifactId>maven-site-plugin</artifactId>
<version>3.3</version>
<configuration>
<skipDeploy>true</skipDeploy>
</configuration>
<dependencies>
<dependency>
<!-- allows markdown syntax for site generation. To use it
place files below src/site/markdown/[filename].md -->
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-module-markdown</artifactId>
<version>1.3</version>
</dependency>
</dependencies>
</plugin>

<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
Expand Down Expand Up @@ -318,6 +358,16 @@
</plugins>
</pluginManagement>
<plugins>

<plugin>
<groupId>com.github.github</groupId>
<artifactId>site-maven-plugin</artifactId>
</plugin>

<plugin>
<artifactId>maven-site-plugin</artifactId>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
Expand All @@ -338,4 +388,19 @@
</repository>
</repositories>

<licenses>
<license>
<name>Apache License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0</url>
<comments>Copyright (c) 2014 DuraSpace</comments>
</license>
</licenses>
<distributionManagement>
<site>
<id>gh-pages</id>
<name>Deployment through GitHub's site deployment plugin</name>
<url>site/${project.version}</url>
</site>
</distributionManagement>

</project>
14 changes: 14 additions & 0 deletions src/site/markdown/index.md.vm
@@ -0,0 +1,14 @@
${project.description}

## About

This is the automatically generated documentation for Fedora 4.

You're probably looking for the [javadocs](apidocs/index.html).

Otherwise, all of the hand-written, community documentation is on the
[wiki](https://wiki.duraspace.org/display/FF/).


## Usage

43 changes: 43 additions & 0 deletions src/site/site.xml
@@ -0,0 +1,43 @@
<project xmlns="http://maven.apache.org/DECORATION/1.3.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0
http://maven.apache.org/xsd/decoration-1.3.0.xsd"
name="fcrepo4">

<skin>
<!-- see http://maven.apache.org/skins/maven-fluido-skin/ -->
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-fluido-skin</artifactId>
<version>1.3.0</version>
</skin>

<body>
<links>
<item name="Fedora" href="http://fcrepo.org/" />
<item name="Fedora 4 on GitHub" href="http://github.com/fcrepo4/" />
<item name="Fedora 4 Developer Documentation" href="http://fcrepo4.github.com/fcrepo4/" />
<item name="Fedora 4 JMS Indexer Developer Documentation" href="http://fcrepo4.github.com/fcrepo-jms-indexer-pluggable/" />
</links>

<breadcrumbs>
<item href="index.html" name="${project.name}" />
</breadcrumbs>

<menu ref="parent" inherit="top" />

<menu ref="modules" inherit="bottom" />

<menu ref="reports" inherit="bottom" />

</body>

<custom>
<fluidoSkin>
<!-- see http://maven.apache.org/skins/maven-fluido-skin/ -->
<topBarEnabled>false</topBarEnabled>
<topBarContainerStyle>width: 80%;</topBarContainerStyle>
<sideBarEnabled>true</sideBarEnabled>
<sourceLineNumbersEnabled>true</sourceLineNumbersEnabled>
</fluidoSkin>
</custom>
</project>

0 comments on commit 3e0e834

Please sign in to comment.