Skip to content

Commit

Permalink
Update docs and remove outdated
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Mar 16, 2013
1 parent a64f57d commit ab91697
Show file tree
Hide file tree
Showing 10 changed files with 6 additions and 136 deletions.
13 changes: 4 additions & 9 deletions _includes/sidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,20 @@
<li class="nav-divider"><a href="index.html"><img src="assets/img/icon-home.png">Home</a></li>
<li><a href="whyyeoman.html"><img src="assets/img/icon-why-yeoman.png">Why Yeoman?</a></li>
<li><img src="assets/img/icon-documentation.png">Documentation (1.0 beta)</li>
<li><a href="gettingstarted_1.0.html"><img src="assets/img/icon-getting-started.png">Getting Started</a></li>
<li><a href="gettingstarted.html"><img src="assets/img/icon-getting-started.png">Getting Started</a></li>
<li class="nav-sub"><a href="road.html">Road to 1.0</a></li>
<li class="nav-sub"><a href="migrate.html">Migrating from 0.9</a></li>
<li class="nav-sub"><a href="handlebars.html">Handlebars integration</a></li>
<li class="nav-sub"><a href="deployment.html">Deployment</a></li>
<li class="nav-sub"><a href="roadmap.html">Roadmap</a></li>
<li class="nav-sub"><a href="support.html">Support</a></li>
<li><img src="assets/img/icon-documentation.png">Documentation (0.9)</li>
<li><a href="gettingstarted.html"><img src="assets/img/icon-getting-started.png">Getting Started</a></li>
<li class="nav-sub"><a href="commandline.html">Command Line</a></li>
<li class="nav-sub"><a href="packagemanager.html">Package Manager</a></li>
<li class="nav-sub"><a href="installation.html">Installation</a></li>
<li class="nav-sub nav-divider"><a href="insight.html">Insight</a></li>
<li class="nav-sub nav-divider"><a href="about.html">About</a></li>
<li class="nav-sub"><a href="about.html">About</a></li>
<li class="nav-divider"><a href="https://github.com/yeoman/yeoman/wiki#096-docs-outdated"><img src="assets/img/icon-documentation.png">Documentation (0.9)</a></li>
<li><a href="faq.html"><img src="assets/img/icon-faqs.png">FAQs</a></li>
<li class="nav-divider"><a href="https://groups.google.com/forum/?fromgroups#!forum/yeoman-dev"><img src="assets/img/icon-discuss.png">Discuss</a></li>
<li><a href="https://plus.google.com/101063139999404044459/posts"><img src="assets/img/icon-google-plus.png">Google Plus</a></li>
<li class="nav-divider"><a href="http://twitter.com/yeoman"><img src="assets/img/icon-twitter.png">Twitter</a></li>
<li><a href="http://github.com/yeoman/yeoman"><img src="assets/img/icon-github.png">GitHub</a></li>
<li><a href="https://github.com/yeoman/yeoman/#contribute"><img src="assets/img/icon-contributing.png">Contributing</a></li>
<li><a href="https://github.com/yeoman/yeoman/blob/master/contributing.md"><img src="assets/img/icon-contributing.png">Contributing</a></li>
</ul>
</nav>
2 changes: 1 addition & 1 deletion _includes/yeoman.wiki
Submodule yeoman.wiki updated from 6d71ff to 4d2b7d
38 changes: 0 additions & 38 deletions commandline.html

This file was deleted.

6 changes: 0 additions & 6 deletions express.html

This file was deleted.

52 changes: 1 addition & 51 deletions gettingstarted.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,54 +3,4 @@
markdown: 1
---

## Quick start

Yeoman supports a powerful set of high-level commands. These include:

{% highlight sh %}
yeoman init # Initialize and scaffold a new project using generator templates
yeoman build # Build an optimized version of your app, ready to deploy
yeoman server # Launch a preview server which will begin watching for changes
yeoman test # Run a Mocha test harness in a headless Phantom.js

yeoman install # Install a package from the client-side package registry
yeoman uninstall # Uninstall the package
yeoman update # Update a package to the latest version
yeoman list # List the packages currently installed
yeoman search # Query the registry for matching package names
yeoman lookup # Look up info on a particular package

{% endhighlight %}

A common initial workflow with Yeoman might be:

{% highlight sh %}
yeoman init # Invoke the most basic application scaffold (Bootstrap, Boilerplate etc.)
yeoman build # Build your project, creating an optimized version in a new `dist` directory
yeoman server # Fire off a file watch/server process which also places an
# intermediate build of your project in `temp`
{% endhighlight %}

Some more examples of how to use our commands include:

{% highlight sh %}
# Generators for MVC/MV* Frameworks
yeoman init quickstart # Skip our questions and get a H5BP, jQuery and Modernizr base
yeoman init bbb # Backbone Boilerplate generator scaffold
yeoman init ember # Ember-Rails generator scaffold
yeoman init backbone # Backbone-Rails generator scaffold

# Coming soon
yeoman init angular # Invoke the AngularJS generator scaffold
yeoman init angular:controller # Invoke the AngularJS Controller sub-generator

# Generator for Chrome Apps
yeoman init chromeapp

# Package management
yeoman search jquery # Lookup jQuery in the Bower registry
yeoman install jquery underscore [depName] # Install a dependency or dependencies
yeoman update jquery # Update a specific dependency (e.g jquery)
{% endhighlight %}

<img src="assets/img/yeoman-007.png" class="character">
{% include yeoman.wiki/Getting-Started.md %}
6 changes: 0 additions & 6 deletions gettingstarted_1.0.html

This file was deleted.

7 changes: 0 additions & 7 deletions handlebars.html

This file was deleted.

6 changes: 0 additions & 6 deletions insight.html

This file was deleted.

6 changes: 0 additions & 6 deletions installation.html

This file was deleted.

6 changes: 0 additions & 6 deletions related.html

This file was deleted.

0 comments on commit ab91697

Please sign in to comment.