High-quality documentation is essential for the success of most software development projects. In the context of a Grunt plugin, its main purpose is to provide instructions and information on the usage of the plugin and its tasks. As with most projects hosted on GitHub, the documentation for a plugin is located in the README.md file, and written in the
Markdown format.
Tip
For more information on the general Markdown format, you can visit the following URLs:
In this recipe, we'll continue to work on the project we created in the Creating a plugin task recipe earlier in this chapter. Be sure to refer to it if you are not yet familiar with its contents.