O'Reilly logo

Grunt Cookbook by Jurie-Jan Botha

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Adding documentation for a plugin

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:

http://daringfireball.net/projects/markdown/

https://help.github.com/articles/github-flavored-markdown/

Getting started

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 ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required