web5design / learn.jquery.com

jQuery Learning Center web site content

The jQuery Learning Site

• Primary Domain: http://learn.jquery.com
• Staging Domain: http://stage.learn.jquery.com

About

The goal of this site is twofold:

1. To serve as a central, trustworthy, narrative compendium of information about how to use jQuery and JavaScript.
2. To remain a timely, vibrant, and community-driven reference with a relatively low barrier to contribution.

Much of the initial content - and spirit - comes from jQuery Fundamentals, an open-source book about jQuery, originally written by Rebecca Murphey and released in 2010. In 2011, Rebecca bequeathed the book unto the jQuery Foundation to serve as the basis for this site.

How This Site Works

This site's core content consists of Markdown files. The template that controls the site's appearance is a child theme of the jQuery web base template, and any issues with the presentation should be directed to that repository.

Site Organization

All of the content lives inside of the subdirectories of the page directory. Each of these subdirectories is considered a chapter, and contains one or more articles, and there is also a top level file that corresponds to each chapter, which contains the chapter's human-readable title and an overview, which will appear on the chapter's landing page.

The order.yml file controls the order that chapters and articles appear in the site.

YAML Conventions

Each of the articles on the site has some YAML "Front Matter" that contains metadata. All articles should include the following:

• title - the title of the article as it will appear in the site. if it contains special characters, put the string in quotes

title: "jQuery Event Extensions"

• level - the approximate level of jQuery experience required to find the article useful. Options: beginner, intermediate, or advanced

level: advanced

Building & Working Locally

As this site is part of the jQuery network of sites, its presentation is controlled by our web base template. To preview the site locally, first follow the instructions there to set up a local version of the jQuery WordPress network. Then, clone this repo and run the following steps (node.js required).

1. npm install
2. cp config-sample.json config.json
3. Edit config.json to use the username and password for your local WordPress network
4. grunt

Windows note: Line endings need to be Unix-style (line-feed only). Make sure your text editor creates new files with Unix-style line endings. In addition, the following setting to your git config will keep the Unix-style line endings when pulling from the repository.

$ git config --global core.autocrlf true

How Can I Help?

We encourage contribution from anyone. For more comprehensive documentation on how to get involved, please read our contributing guide.