finereport2001 / markdown-doclet

Automatically exported from code.google.com/p/markdown-doclet
Other
0 stars 0 forks source link

Support Maven #6

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
{{
<project>
  ...
  <reporting> (or <build>)

    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.6.1</version>

        <configuration>
          <doclet>com.visural.doclets.markdown.standard.Standard</doclet>

          <!-- <docletPath>/path/to/UmlGraph.jar</docletPath> -->

          <docletArtifact>
            <groupId>com.visural.doclets.markdown</groupId>
            <artifactId>markdown</artifactId>
            <version>2.0</version>

          </docletArtifact>
          <useStandardDocletOptions>true</useStandardDocletOptions>
        </configuration>
      </plugin>
    ...
    </plugins>
  </reporting> (or </build>)

  ...
</project>

}}

- Utilise the maven javadoc plugin as part of either the build or reporting 
lifecycle
- Set doclet to <doclet>com.visural.doclets.markdown.standard.Standard</doclet>
- You could use docletPath to point to the markdown jar locally (as markdown 
doesn't reside in a maven repo yet) however that kinda defeats the point.  So 
best would be to just install to you local repo 
(http://maven.apache.org/guides/mini/guide-3rd-party-jars-local.html) first

Original issue reported on code.google.com by tibe...@gmail.com on 7 Jul 2010 at 6:10

GoogleCodeExporter commented 9 years ago
I would gladly lend a hand dropping in a pom for deploy to central; you can 
submit for free through sonatype.org.

The guide looks a little scary,
https://docs.sonatype.org/display/Repository/Sonatype+OSS+Maven+Repository+Usage
+Guide
but the only thing you would have to do is generate a GPG key on the enviro 
from which you run deploy.  The pom I can send you will config all the rest (I 
think).

Free help if you want it!

Original comment by Ja...@wetheinter.net on 23 Mar 2013 at 11:32

GoogleCodeExporter commented 9 years ago
Any changes here?

Original comment by gre...@gmail.com on 18 May 2013 at 6:07