# Documentation

AEM supports README.md files inside components which will render the README.md files on the component detail page: http://localhost:4502/libs/wcm/core/content/sites/components.html

This Jetpack tool re-uses some part of this component to render README.md files which are not stored in a component.

# Biggest advantages

• Re-use of README.md content in component documentation
• Possibility to render README.md in AEM for non-components

# Ready to try this out?

1. Install the repository in your AEM environment or download the zip file.
2. Go to http://localhost:4502/apps/jetpack/documentation/content/details.html/apps/jetpack/documentation/example

# Want to learn more on how this works?

1. Put a README.md in any folder you want (suggested in /apps/)
2. Request this README.md using a path like this: /apps/jetpack/documentation/content/details.html/apps/documentation/path/here

To link from another readme to this readme, use the following markdown syntax:

 [Example Documentation](/apps/jetpack/documentation/content/details.html/apps/jetpack/documentation/example)

3. Write component documentation as we documented in this medium post.