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: content/writers-guide.md
+37-4Lines changed: 37 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,49 @@
2
2
title: Writer's Guide
3
3
---
4
4
5
+
The following sections contain all you need to know about editing and formatting the content within this site. Make sure to do some research before starting your edits or additions. Sometimes the toughest part is finding where the content should live and determining whether or not it already exists.
6
+
7
+
5
8
## Process
6
9
7
10
1. Check related issue if an article links to one.
8
11
2. Hit `edit` and expand on the structure.
9
12
3. PR changes.
10
13
14
+
15
+
## YAML Frontmatter
16
+
17
+
Each article contains a small section at the top written in [YAML Frontmatter]():
18
+
19
+
```md
20
+
---
21
+
title: My Article
22
+
sort: 3
23
+
contributors:
24
+
- [github username]
25
+
related:
26
+
- title: Title of Related Article
27
+
url: [url of related article]
28
+
---
29
+
```
30
+
31
+
Let's break these down:
32
+
33
+
-`title`: The name of the article.
34
+
-`sort`: The order of the article within its section.
35
+
-`contributors`: A list of GitHub usernames who have contributed to this article.
36
+
-`related`: Any related reading or useful examples.
37
+
38
+
Note that `related` will generate a __Further Reading__ section at the bottom of the page and `contributors` will yield a __Contributors__ section below it. If you edit an article and would like recognition, please feel free to add your GitHub username to the `contributors` list.
39
+
40
+
11
41
## Article Structure
12
42
13
-
1. Brief introduction - a paragraph or two so you get the basic idea. Tell what you are going to tell.
14
-
2. Main content - tell what you promised to tell.
15
-
3. Conclusion - tell what you told and recap the main points.
16
-
4. References - link to related articles and external resources so people can read and learn more about the topic.
43
+
1. Brief Introduction - a paragraph or two so you get the basic idea about the what and why.
44
+
2. Outline Remaining Content – how the content will be presented.
45
+
3. Main Content - tell what you promised to tell.
46
+
4. Conclusion - tell what you told and recap the main points.
47
+
17
48
18
49
## Running the Site
19
50
@@ -23,6 +54,7 @@ title: Writer's Guide
23
54
24
55
The site will update itself as you make changes.
25
56
57
+
26
58
## Typesetting
27
59
28
60
* webpack should always be written in lower-case letters. Even at the beginning of a sentence. ([source](https://github.com/webpack/media#name))
@@ -31,6 +63,7 @@ The site will update itself as you make changes.
31
63
* Use "webpack 2" to refer to a specific webpack version (~~"webpack v2"~~)
32
64
* Use ES5; ES2015, ES2016, … to refer to the ECMAScript standards (~~ES6~~, ~~ES7~~)
0 commit comments