maven markdown maven-site-plugin

¿Cómo usar el descuento para el sitio del proyecto maven?



markdown maven-site-plugin (2)

¿Cómo comenzar con la documentación del proyecto usando Maven y el lenguaje de marcado de rebajas? El sitio predeterminado de Maven es APT, lo cual es incómodo para aprender a hacer las cosas de la misma manera. (Por lo general, nadie en un equipo comenzará a escribir la documentación del sitio de maven cuando también necesiten aprender un lenguaje de marcado más en el camino).

¿Alguien ha intentado usar el marcado (el mismo lenguaje de marcado que se usa en github) para la documentación del sitio del proyecto Maven? Veo de referencias de Maven Doxia que es posible. ¿Cualquier problema?

Soy nuevo en la generación de sitios de maven. Creo que es mejor empezar con el descuento, que con otros lenguajes de marcado, con los que el equipo no ha trabajado.

ACTUALIZAR. Tenido éxito Ver la respuesta a continuación.

Cita de http://maven.apache.org/doxia/references/index.html

Agrega esto a pom.xml

<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> <version>3.2</version> <dependencies> <dependency> <groupId>org.apache.maven.doxia</groupId> <artifactId>doxia-module-markdown</artifactId> <version>1.3</version> </dependency> </dependencies> </plugin>

Luego, comience a agregar páginas en src/site/markdown/ con la extensión .md . Para cada elemento de menú agregar página como en sniplet a continuación:

<body> <!-- http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/decoration.html <item collapse=.. ref=.. name=.. href="README" img=.. position=.. alt=.. border=.. width=.. height=.. target=.. title=.. > --> <menu name="User guide"> <item href="README.html" name="README" /> </menu> <menu ref="reports" inherit="bottom" /> </body>

Que usar el mvn site para generar el sitio. Mire el target/site para revisar los resultados.

mvn site:stage -DstagingDirectory=C:/TEMP/fullsite para obtener el sitio del proyecto multi-modular en una sola carpeta.

Lea más acerca de maven-site-plugin .

Recomiendo usar maven-fluido-skin . Es el estilo más nuevo, basado en Twitter Bootstrap. Agregar esto a site.xml

<project name="xxx"> [...] <skin> <groupId>org.apache.maven.skins</groupId> <artifactId>maven-fluido-skin</artifactId> <version>1.3.0</version> </skin> [...] </project>

Ver también https://github.com/winterstein/Eclipse-Markdown-Editor-Plugin