Skip to content

Commit 2f43edf

Browse files
committed
Docs: order.yml -> order.json
1 parent 08690e1 commit 2f43edf

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Of course, we'll also give you credit for your work! The **Contributors** sectio
2424

2525
### Content
2626

27-
The content in this site is maintained in [this GitHub repository](https://github.com/jquery/learn.jquery.com) as a collection of [Markdown](http://daringfireball.net/projects/markdown/) files in the `page` directory. The order in which chapters and articles are presented is controlled by the [order.yml](https://github.com/jquery/learn.jquery.com/blob/master/order.yml) file.
27+
The content in this site is maintained in [this GitHub repository](https://github.com/jquery/learn.jquery.com) as a collection of [Markdown](http://daringfireball.net/projects/markdown/) files in the `page` directory. The order in which chapters and articles are presented is controlled by the [order.json](https://github.com/jquery/learn.jquery.com/blob/master/order.json) file.
2828

2929
### Design
3030

@@ -75,7 +75,7 @@ For more advice on managing your fork and submitting pull requests to the jQuery
7575
### Adding a New Article
7676

7777
1. Add the file to the right folder in the `page` folder.
78-
2. Add the slug name (the filename without the extension) to the desired location in `order.yml`
78+
2. Add the slug name (the filename without the extension) to the desired location in `order.json`
7979
3. Run `grunt`
8080
4. You should now be able to navigate to the file.
8181

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,20 @@ This site's core content consists of [Markdown](http://daringfireball.net/projec
2121

2222
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.
2323

24-
The [`order.yml`](https://github.com/jquery/learn.jquery.com/blob/master/order.yml) file controls the order that chapters and articles appear in the site.
24+
The [`order.json`](https://github.com/jquery/learn.jquery.com/blob/master/order.json) file controls the order that chapters and articles appear in the site.
2525

2626

27-
### YAML Conventions
27+
### Front Matter
2828

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

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.
3232

33-
`title: "jQuery Event Extensions"`
33+
`"title": "jQuery Event Extensions"`
3434

3535
* `level` - The approximate level of jQuery experience required to find the article useful. Options: `beginner`, `intermediate`, or `advanced`.
3636

37-
`level: advanced`
37+
`"level": "advanced"`
3838

3939

4040
## Building & Working Locally

0 commit comments

Comments
 (0)