Maven site plugin

publikováno: 8.8.2013

Určitě jste už u nějakého projektu viděli takový web:

Maven site plugin

Takové weby jsou vytvořené pomocí Maven site pluginu. Jak ho použít? Přidejte do pom.xml dovnitř tagu <plugins>:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-site-plugin</artifactId>
  <version>3.3</version>
</plugin>

Dále spusťte Váš Maven projekt:

mvn site:site

Tímto vytvoříte v adresáři target/site Váš web.

Vzhled webu a informace na něm můžete opravdu hodně extenzivně změnit. Více na domovských stránkách pluginu: http://maven.apache.org/plugins/maven-site-plugin/

edit: Právě jsem dokončil jeden takový velice jednoduchý web: http://jsitemapgenerator.jiripinkas.cz/ Jak na to?

  1. Na stránce http://maven.apache.org/plugins/maven-site-plugin/examples/creating-content.html je popsáno, že v projektu by měl být soubor /src/site/site.xml, který má následující syntax: http://maven.apache.org/xsd/decoration-1.3.0.xsd a jeho ukázka je zde: http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/decoration.html (pozor! V současnosti verze 1.4.0 jako je na ukázce neexistuje, ale verze 1.3.0 funguje perfektně).
  2. Poté je třeba vytvořit vlastní stránky s vlastním obsahem jako je např. index.html. Ty se vytvářejí v jednom ze tří formátů: APT, FML, XDOC, mě nejvíc přirostl k srdci XDOC, který je popsán na této stránce: http://maven.apache.org/doxia/references/xdoc-format.html. Takový soubor se pak v projektu nachází na následujícím umístění: src/site/xdoc/index.html
  3. Další vlastní stránky kromě index.html se musí zapojit v site.xml. Toto a víc je popsáno zde: http://maven.apache.org/plugins/maven-site-plugin/examples/sitedescriptor.html
  4. Je možné do stránky přidat automaticky generované reporty jako je javadoc a kód pro Maven/Ivy/Gradle atd. Jak na to je popsáno zde: http://maven.apache.org/plugins/maven-site-plugin/examples/configuring-reports.html
  5. Maven site plugin toho umí daleko víc, vše je popsáno v dokumentaci, ale čtení dokumentace dá relativně dost práce než se v tom člověk zorientuje, pak je to ale velice jednoduché a logické.

Reference

Líbilo se mi celé pojetí kurzu - možná trošku netradiční, nicméně dělané ajťákem pro ajťáky. :-) ("normální" člověk, který by se na kurzu náhodou ocitl, by asi nechápal). Vše bylo

Martin

Školení pro nás bylo velice přínosné. Ocenil jsem zejména konzultace vhodnosti použití přímo nad reálnými problémy v našem projektu. Výklad byl plně customizovaný našim potřebám a znalostem. Celkově velká spokojenost.

Jiří

Školení se mi opravdu líbilo. Jako vždy bylo vidět, že pan Pinkas se v dané oblasti dobře orientuje a ví jak se Docker používá v praxi. Vysvětlení pojmů vždy prijde

Zdeněk


Novinky

9.5.2019: Plánovaný přechod Java EE -> Jakarta EE
Posledních několik měsíců intenzivně sleduji plánovaný přechod z Java EE na Jakarta EE. A musím říct, že to je shit-show :-(

22.3.2019: Termíny Java školení léto 2019
Nové termíny!!!

22.3.2019: Vyšla Java 12!
Java 12 je venku!!!