You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-11
Original file line number
Diff line number
Diff line change
@@ -10,12 +10,12 @@ The goal of this site is twofold:
10
10
1. To serve as a central, trustworthy, narrative compendium of information about how to use jQuery and JavaScript.
11
11
2. To remain a timely, vibrant, and community-driven reference with a relatively low barrier to contribution.
12
12
13
-
Much of the initial content - and spirit - comes from [jQuery Fundamentals](https://github.com/rmurphey/jqfundamentals), an open-source book about jQuery, originally written by [Rebecca Murphey](http://www.rmurphey.com/) and released in 2010. In 2011, Rebecca [bequeathed the book](http://rmurphey.com/blog/2011/03/17/the-future-of-jquery-fundamentals-and-a-confession/) unto the jQuery Foundation to serve as the basis for this site.
13
+
Much of the initial content - and spirit - comes from [jQuery Fundamentals](http://jqfundamentals.com/legacy), an open-source book about jQuery, originally written by [Rebecca Murphey](http://www.rmurphey.com/) and released in 2010. In 2011, Rebecca [bequeathed the book](http://rmurphey.com/blog/2011/03/17/the-future-of-jquery-fundamentals-and-a-confession/) unto the jQuery Foundation to serve as the basis for this site.
14
14
15
15
16
16
## How This Site Works
17
17
18
-
This site's core content consists of [Markdown](http://daringfireball.net/projects/markdown/) files. The template that controls the site's appearance is a [child theme](https://github.com/jquery/jquery-wp-content/tree/master/themes/learn.jquery.com) of the jQuery [web base template](https://github.com/jquery/jquery-wp-content), and any issues with the presentation should be directed to [that repository](https://github.com/jquery/jquery-wp-content).
18
+
This site's core content consists of [Markdown](http://daringfireball.net/projects/markdown/) files. The template that controls the site's appearance is a [child theme](https://github.com/jquery/jquery-wp-content/tree/master/themes/learn.jquery.com) of [jquery-wp-content](https://github.com/jquery/jquery-wp-content), and any issues with the presentation should be directed to [that repository](https://github.com/jquery/jquery-wp-content).
19
19
20
20
### Site Organization
21
21
@@ -26,30 +26,26 @@ The [`order.yml`](https://github.com/jquery/learn.jquery.com/blob/master/order.y
26
26
27
27
### YAML Conventions
28
28
29
-
Each of the articles on the site has some [YAML "Front Matter"](https://github.com/mojombo/jekyll/wiki/YAML-Front-Matter) that contains metadata. All articles should include the following:
29
+
Each of the articles on the site has some [YAML "Front Matter"](http://jekyllrb.com/docs/frontmatter/) that contains metadata. All articles should include the following:
30
30
31
-
* title - the title of the article as it will appear in the site. if it contains special characters, put the string in quotes
31
+
*`title` - The title of the article as it will appear in the site. If it contains special characters, put the string in quotes.
32
32
33
33
`title: "jQuery Event Extensions"`
34
34
35
-
* level - the approximate level of jQuery experience required to find the article useful. Options: `beginner`, `intermediate`, or `advanced`
35
+
*`level` - The approximate level of jQuery experience required to find the article useful. Options: `beginner`, `intermediate`, or `advanced`.
36
36
37
37
`level: advanced`
38
38
39
-
## Building & Working Locally
40
39
41
-
As this site is part of the jQuery network of sites, its presentation is controlled by our [web base template](https://github.com/jquery/jquery-wp-content). To preview the site locally, first follow the [instructions there](https://github.com/jquery/jquery-wp-content) to set up a local version of the jQuery WordPress network. Then, clone this repo and run the following steps (node.js required).
40
+
## Building & Working Locally
42
41
42
+
As this site is part of the jQuery network of sites, its presentation is controlled by [jquery-wp-content](https://github.com/jquery/jquery-wp-content). To preview the site locally, first follow the [instructions there](https://github.com/jquery/jquery-wp-content) to set up a local version of the jQuery WordPress network. Then, clone this repo and run the following steps (node.js required).
43
43
44
44
1.`npm install`
45
45
2.`cp config-sample.json config.json`
46
46
3. Edit config.json to use the username and password for your local WordPress network
47
47
4.`grunt`
48
48
49
-
```
50
-
$ git config --global core.autocrlf true
51
-
```
52
-
53
49
## How Can I Help?
54
50
55
51
We encourage contribution from anyone. For more comprehensive documentation on how to get involved, please read our [contributing guide](http://learn.jquery.com/contributing).
0 commit comments