CINXE.COM

<!DOCTYPE html><html lang="en" prefix="og: http://ogp.me/ns#" itemscope itemtype="http://schema.org/WebPage"><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>Documentation - Grunt: The JavaScript Task Runner</title><link rel="stylesheet" href="/css/main.css"><link rel="apple-touch-icon" href="/img/favicons/apple-touch-icon.png" sizes="180x180"><link rel="icon" type="image/png" href="/img/favicons/favicon-32x32.png" sizes="32x32"><link rel="icon" type="image/png" href="/img/favicons/favicon-16x16.png" sizes="16x16"><link rel="manifest" href="/img/favicons/manifest.json"><link rel="mask-icon" href="/img/favicons/safari-pinned-tab.svg" color="#e48632"><link rel="shortcut icon" href="/img/favicons/favicon.ico" type="image/x-icon"><meta name="msapplication-config" content="/img/favicons/browserconfig.xml"><meta name="theme-color" content="#e48632"><meta property="og:title" content="Documentation - Grunt: The JavaScript Task Runner"><meta property="og:type" content="website"><meta property="og:url" content="https://gruntjs.com/"><meta property="og:image" content="https://gruntjs.com/img/og.png"><meta property="og:image:type" content="image/png"><meta property="og:image:width" content="256"><meta property="og:image:height" content="256"><meta name="twitter:card" content="summary_large_image"><meta name="twitter:creator" content="@gruntjs"><meta name="twitter:site" content="@gruntjs"><meta name="twitter:title" content="Documentation - Grunt: The JavaScript Task Runner"><meta itemprop="name" content="Grunt"><meta itemprop="image" content="/img/og.png"><link href="/rss" rel="alternate" title="Grunt Blog Feed" type="application/atom+xml"></head><body class="page-docs page-secondary"><div class="banner"> <a href="support">V1.6.1 is the current version, and previous versions are not supported. Upgrade to the latest version or consider other support options.</a></div><div class="navbar navbar-inverse"><div class="navbar-inner"><div class="container"><a class="brand" href="/"><span class="logo"></span></a><div class="nav-collapse collapse"><ul class="nav"><li><a href="/getting-started"><i class="icon-arrow-right"></i><span>Getting Started</span></a></li><li><a href="/configuring-tasks"><i class="icon-cog"></i><span>Configuring Tasks</span></a></li><li><a href="/plugins"><i class="icon-power-cord"></i><span>Plugins</span></a></li><li><a href="/documentation"><i class="icon-file-text"></i><span>Documentation</span></a></li><li><a href="/support"><i class="icon-file-text"></i><span>Support</span></a></li></ul><form class="navbar-search pull-right"><input class="search-query" type="text" placeholder="Search"></form></div></div></div></div><div class="content"><div class="container documentation"><div class="row-fluid"><div class="span9 page"><div class="hero-unit"><h1>Documentation</h1><p>Welcome to the Grunt documentation page. Here you can find helpful resources, links, and information to start using Grunt. The first step to perform to use the tool is <a href="https://gruntjs.com/installing-grunt">to install it</a> on your machine.</p> <h2><a class="anchor" href="#getting-started" id="getting-started"></a>Getting started</h2> <p>If you're new to Grunt's world, we suggest to learn more about our CLI and what actions you need to complete to use Grunt in your project. The best resource for that is our <a href="https://gruntjs.com/getting-started">Getting started guide</a>. If you already know what Grunt is and how it works, the next step is to familiarize yourself with <a href="https://gruntjs.com/configuring-tasks">the creation of a <code>Gruntfile</code></a>. A <code>Gruntfile</code> contains the configuration of the tasks you wish to employ. If you are curious to know how it looks like, you can check out <a href="https://gruntjs.com/sample-gruntfile">our sample</a>.</p> <h2><a class="anchor" href="#advanced" id="advanced"></a>Advanced</h2> <p>Once mastered all the basic concepts you might want to create your own Grunt tasks. Our <a href="https://gruntjs.com/creating-plugins">step-by-step guide</a> and <a href="https://gruntjs.com/api/grunt">the API documentation page</a> will help you in achieving this goal.</p> <p>Grunt helps you ship better projects by automating many tasks. If you feel grateful and want to give something back, the project is always on the outlook for new contributors. To see how you can help, take a look at the <a href="https://gruntjs.com/contributing">Contributing page</a>.</p> <h2><a class="anchor" href="#help-and-support" id="help-and-support"></a>Help and support</h2> <p>Do you feel lost? We got you covered. Our dedicated <a href="https://gruntjs.com/frequently-asked-questions">F.A.Q. page</a> should give the answers you need. If you can't find what you're looking for, you can search for more support in our <a href="https://gruntjs.com/help-resources">Help Resources page</a>. In addition, our community will try to assist you in our <a href="http://webchat.freenode.net/?channels=grunt">#grunt channel on irc.freenode.net</a>.</p> <h2><a class="anchor" href="#where-to-go-next" id="where-to-go-next"></a>Where to go next?</h2> <p>Here's a summary of the documentation pages you can find on this website:</p> <div class="row-fluid"> <div class="span6"> <h3>Documentation</h3> <ul> <li><a href="https://gruntjs.com/getting-started">Getting Started</a></li> <li><a href="https://gruntjs.com/configuring-tasks">Configuring Tasks</a></li> <li><a href="https://gruntjs.com/sample-gruntfile">Sample Gruntfile</a></li> <li><a href="https://gruntjs.com/creating-tasks">Creating Tasks</a></li> <li><a href="https://gruntjs.com/creating-plugins">Creating Plugins</a></li> <li><a href="https://gruntjs.com/using-the-cli">Using the CLI</a></li> </ul> </div> <div class="span6"> <h3>Advanced</h3> <ul> <li><a href="https://gruntjs.com/api">API</a></li> <li><a href="https://gruntjs.com/installing-grunt">Installing Grunt</a></li> <li><a href="https://gruntjs.com/frequently-asked-questions">Frequently Asked Questions</a></li> <li><a href="https://gruntjs.com/project-scaffolding">Project Scaffolding</a></li> </ul> </div> </div> <div class="end-link">Found an error in the documentation? <a href='https://github.com/gruntjs/grunt-docs/issues'>File an issue</a>.</div></div></div><div class="span3"><div class="well sidebar-nav"><ul class="nav nav-list"><li class="nav-header"><i class="icon-file-text"></i><span>Documentation</span></li><li><a href="/getting-started">Getting Started</a></li><li><a href="/configuring-tasks">Configuring Tasks</a></li><li><a href="/sample-gruntfile">Sample Gruntfile</a></li><li><a href="/creating-tasks">Creating Tasks</a></li><li><a href="/creating-plugins">Creating Plugins</a></li><li><a href="/using-the-cli">Using the CLI</a></li></ul><ul class="nav nav-list"><li class="nav-header"><span>Advanced</span></li><li><a href="/api">API</a></li><li><a href="/installing-grunt">Installing Grunt</a></li><li><a href="/frequently-asked-questions">Frequently Asked Questions</a></li><li><a href="/project-scaffolding">Project Scaffolding</a></li></ul><ul class="nav nav-list"><li class="nav-header"><span>Community</span></li><li><a href="/support">Support</a></li><li><a href="/help-resources">Help Resources</a></li><li><a href="/who-uses-grunt">Who uses Grunt</a></li><li><a href="/built-with-grunt-badge">Built with Grunt Badge</a></li><li><a href="/contributing">Contributing</a></li><li><a href="/development-team">Development Team</a></li></ul><ul class="nav nav-list"><li class="nav-header"><span>Migration guides</span></li><li><a href="/upgrading-from-0.3-to-0.4">Upgrading from 0.3 to 0.4</a></li><li><a href="/upgrading-from-0.4-to-1.0">Upgrading from 0.4 to 1.0</a></li></ul></div></div></div></div></div><footer class="grunt-footer"><div class="inner"><div class="container"><ul class="pull-right"><li><a href="/blog">Blog</a></li><li><a href="/upgrading-from-0.3-to-0.4">Migration Guides</a></li><li><a href="/contributing">Contributing</a></li><li><a href="/development-team">Development Team</a></li><li class="social"><a href="https://github.com/gruntjs/" title="Grunt on GitHub"><span class="icon-github"></span></a></li><li class="social"><a href="https://twitter.com/gruntjs/" title="Grunt on Twitter"><span class="icon-twitter"></span></a></li><li class="social"><a href="/rss" title="Grunt blog RSS feed"><span class="icon-rss"></span></a></li><li class="openjs"><a href="https://openjsf.org/" title="OpenJS Foundation"><img src="/img/openjsf-color-textw.svg" alt="OpenJS Foundation" width="100" height="31"></a></li></ul></div></div></footer></body></html>