Add documentation for the IGB Manager
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.
Create README.md file to include with your App
To add documentation to your App:
- Create a file named README.md
- Save it in the top level of your IGB App project (same level as pom.xml)
- Edit your pom.xml file as follows
Add Bundle-Description tag to pom.xml
Add a Bundle-Description tag within the instructions tag of the org.apache.felix maven-bundle-plugin section of your pom.xml:
Code Block | ||||
---|---|---|---|---|
| ||||
<Bundle-Description>${bundleDescription}</Bundle-Description> |
Add bundle-markdown-encoder plugin (from IGB project)
Also add the following plugin (as a child of the plugins tag):
Code Block | ||||
---|---|---|---|---|
| ||||
<plugin>
<groupId>com.lorainelab</groupId>
<artifactId>bundle-markdown-encoder</artifactId>
<executions>
<execution>
<goals>
<goal>encodeMarkdown</goal>
</goals>
</execution>
</executions>
</plugin> |