IGB can display formatted text in the right panel of the IGB App Manager. Explain how to use your App by creating a README.md (markdown) file - this should reside at the top-level of your App project.
To add documentation to your App:
Add a Bundle-Description tag within the instructions tag of the org.apache.felix maven-bundle-plugin section of your pom.xml:
<Bundle-Description>${bundleDescription}</Bundle-Description> |
Also add the following plugin (as a child of the plugins tag):
<plugin> <groupId>com.lorainelab</groupId> <artifactId>bundle-markdown-encoder</artifactId> <executions> <execution> <goals> <goal>encodeMarkdown</goal> </goals> </execution> </executions> </plugin> |