yogsototh/marginalia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #47 from hugoduncan/add-zi-to-readme

Browse source 
Add zi plugin documentation for running marginalia from maven
This commit is contained in:
Fogus 2011-07-16 07:33:37 -07:00
commit 23f51feaef
1 changed files with 38 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -68,7 +68,44 @@ After that, you should be able to use it like any other cake task:
### Maven
Not yet supported.
The [zi plugin](https://github.com/pallet/zi) supports marginalia.
Add the folowing to your `pom.xml`, and run `mvn zi:marginalia`.
```xml
<plugin>
<groupId>org.cloudhoist.plugin</groupId>
<artifactId>zi</artifactId>
<version>0.3.1</version>
<configuration>
<marginaliaTargetDirectory>autodoc/marginalia</marginaliaTargetDirectory>
</configuration>
</plugin>
```
And the following to your `settings.xml`.
```xml
<pluginGroups>
<pluginGroup>org.cloudhoist.plugin</pluginGroup>
</pluginGroups>
<profiles>
<profile>
<id>clojure-dev</id>
<pluginRepositories>
<pluginRepository>
<id>sonatype-snapshots</id>
<url>http://oss.sonatype.org/content/repositories/releases</url>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
<activeProfiles>
<activeProfile>clojure-dev</activeProfile>
</activeProfiles>
```
Contributors and thanks
-----------------------