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: page/style-guide.md
+11-10Lines changed: 11 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -10,28 +10,29 @@ customFields:
10
10
11
11
## Formatting Conventions
12
12
13
-
Articles in the learn site are authored with [GitHub Flavored Markdown](http://github.github.com/github-flavored-markdown/), and the beginning of each article contains some [YAML](http://www.yaml.org/) "front matter" that contains metadata used when the article is published.
13
+
Articles in the learn site are authored with [GitHub Flavored Markdown](http://github.github.com/github-flavored-markdown/), and the beginning of each article contains some JSON "front matter" that contains metadata used when the article is published.
14
14
15
15
### Article Header Metadata
16
16
17
17
Each article should have the following header (see below as some metatags are optional):
18
18
19
19
```
20
-
---
21
-
title: <article title>
22
-
level: [beginner|intermediate|advance]
23
-
source: <url of source of the material derived>
24
-
attribution:
25
-
- Ralph Whitbeck <ralph@email.com>
26
-
- John Paul <john@email.com>
27
-
---
20
+
<script>{
21
+
"title": <article title>,
22
+
"level": [beginner|intermediate|advance],
23
+
"source": <url of source of the material derived>,
24
+
"attribution": [
25
+
"Ralph Whitbeck <ralph@email.com>",
26
+
"John Paul <john@email.com>"
27
+
]
28
+
}</script>
28
29
```
29
30
30
31
The `source` and `attribution` properties are optional, and should be used primarily if you are importing an article from an outside source where it was published before being donated for inclusion in the learn site. You should **not** include these properties if you are adding a new article or editing an existing one, as your contribution will be acknowledged via the git commit logs.
31
32
32
33
### Code Blocks
33
34
34
-
Code blocks should be set off with triple backticks and should **not** be indented. (That is to say, the site prefers the use of "fenced blocks"notation supported by [gfm](http://github.github.com/github-flavored-markdown/).)
35
+
Code blocks should be set off with triple backticks and should **not** be indented. (That is to say, the site prefers the use of "fenced blocks"notation supported by [gfm](http://github.github.com/github-flavored-markdown/).)
0 commit comments