|
1 |
| -# Learn.jQuery.com |
| 1 | +# The jQuery Learning Site |
2 | 2 |
|
3 | 3 | * Primary Domain: [http://learn.jquery.com](http://learn.jquery.com)
|
| 4 | +* Staging Domain: [http://learn.jquery.com](http://stage.learn.jquery.com) |
4 | 5 |
|
5 |
| -# How Do I Get This Running Locally |
| 6 | +## About |
6 | 7 |
|
7 |
| -* Clone/fork this repo |
8 |
| -* Install our lovely friends "The Dependencies"<br/> |
9 |
| -`> gem install nanoc kramdown adsf mime-types curb json` |
10 |
| -* Change to the newly cloned repository's directory |
| 8 | +Spread across the internet is lot of information about how to learn and use jQuery. This content ranges in quality from excellent to terrible, and is often stuck inside CMSes where only the original author can ever update the content. The goal of this site is twofold |
| 9 | + |
| 10 | +1. To serve as a central, trustworthy, narrative compendium of information about how to use jQuery and JavaScript |
| 11 | +2. To remain an timely, vibrant, and community-driven reference with a low barrier to contribution |
| 12 | + |
| 13 | +Much of the initial content - and spirit - is from [jQuery Fundamentals](https://github.com/rmurphey/jqfundamentals), an open-source book about jQuery, originally released in 2010 by [Rebecca Murphe](http://www.rebeccamurphey.com/) and bequeathed unto the jQuery Project to serve as the foundation for this site. |
| 14 | + |
| 15 | +This site consists of content maintained in [Markdown](http://daringfireball.net/projects/markdown/) files, powered by [nanoc](http://nanoc.stoneship.org/), a Ruby-based [static site generator](http://www.mickgardner.com/2011/04/27/An-Introduction-To-Static-Site-Generators.html) |
| 16 | + |
| 17 | +## How Can I Get Involved? |
| 18 | + |
| 19 | +The entire site is managed via this Git repository. If you'd like to contribute new articles, make edits to existing content, or work on the site's frontend or backend code, the first thing you'll need is a [fork](http://help.github.com/fork-a-repo/). When you have changes you'd like to have reviewed and integrated into the site, submit a [pull request](http://help.github.com/send-pull-requests/). |
| 20 | + |
| 21 | +If you aren't already familiar with Git, you'll still need a fork and a GitHub account, but you can can edit files directly via [GitHub's in-browser editor](https://github.com/blog/905-edit-like-an-ace), but you won't be able to create new content. We encourage you to [learn how to use Git andGitHub](http://help.github.com/), it'll probably pretty useful no matter what. |
| 22 | + |
| 23 | + |
| 24 | +## How Do I Get This Running Locally? |
| 25 | + |
| 26 | +*This project requires Ruby >= 1.9 and [Bundler](http://gembundler.com/). If you don't already have a Ruby development environment, please see the corresponding section below.* |
| 27 | + |
| 28 | +*If you **only** want to work with and edit content, you don't actually have to get the project running locally, you can just edit/add Markdown content inside of the `content` directory. Of course, you won't be able to preview your content locally* |
| 29 | + |
| 30 | +* Clone/fork this repo<br/> |
| 31 | +* Change to the newly cloned repository's directory<br/> |
| 32 | +`> cd learn.jquery.com` |
| 33 | +* Install the dependencies<br/> |
| 34 | +`> gem install bundler && bundle install` |
11 | 35 | * Run the nanoc server<br/>
|
12 | 36 | `> nanoc view &`
|
13 |
| -* The site should be running on _http://localhost:3000. Use the `--port` option to specify a different port. |
14 |
| -* Set the site to watch for changes and re-compile |
| 37 | +* The site should be running on http://localhost:3000. Use the `--port` option to specify a different port. |
| 38 | +* Set the site to watch for changes and re-compile<br/> |
15 | 39 | `> nanoc watch`
|
| 40 | + |
| 41 | +## I Don't (Know If I?) Already Have a Ruby Development Environment |
| 42 | + |
| 43 | +#### Mac OS X/Linux: |
| 44 | + |
| 45 | +You actually probably already **do** have some of Ruby available, but it's probably not Ruby 1.9. We recommend setting up: |
| 46 | +* [rbenv](https://github.com/sstephenson/rbenv) |
| 47 | +* [ruby-build](https://github.com/sstephenson/ruby-build) |
| 48 | +* [rbenv-bundler](https://github.com/carsomyr/rbenv-bundler) |
| 49 | +* [rbenv-gemset](https://github.com/jamis/rbenv-gemset) |
| 50 | + |
| 51 | +Once you get that all squared away (and yes, we know that might be a big 'once'), you'll want to set your fork to use the Ruby > 1.9 you installed while you were setting up `rbenv`. |
| 52 | + |
| 53 | +`cd ~/myfiles/learn.jquery.com` |
| 54 | +`rbenv local 1.9.3-p0` |
| 55 | + |
| 56 | +Then, you can follow the instructions above, starting at "Install the dependencies" |
| 57 | + |
| 58 | +#### Windows |
| 59 | + |
| 60 | +* Grab the latest Ruby package from the Windows-only [rubyinstaller.org](http://rubyinstaller.org/) |
| 61 | +* Install it |
| 62 | +* [Meta-bullet point: This section probably lacks detail. If a Windows-Ruby developer wants to help us flesh this section out, that would be great!] |
| 63 | +* Follow the instructions above, starting at "Install the dependencies" |
0 commit comments