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
+45-5Lines changed: 45 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,6 @@ Contributing by creating content or suggestion changes to existing content can b
9
9
When you're done with a draft you can create a pull request. This will give the content team the possibility to review it and leave comments or request changes. During this review process you can continue to push commits to the same branch. They will show up in the pull request automatically. Once the pull request gests merged into master, the content will be deployed to the staging server where you will be able to have a final look on how it looks on the website. When everything looks fine, one of the repository maintainers will create a release of the latest version. This will then be automatically deployed to the production server.
10
10
11
11
12
-
13
12
# How Do I Use Markdown to Write Content?
14
13
15
14
Markdown is a simple language that forces authors to focus on semantics rather than styling. Therefore it's important to adhere to the convetions mentioned in this document. This will ensure proper rendering of the content on the website.
@@ -44,7 +43,7 @@ Links can be added by using the following syntax: `[I'm a link](https://www.goog
44
43
45
44
## How Can I Add Line Breaks?
46
45
47
-
To create a line break (`<br>`), end a line with two or more spaces, and then hit return.
46
+
To create a line break (`<br>`), end a line with two or more spaces, and then hit return.
48
47
```
49
48
This is the first line.
50
49
And this is the second line.
@@ -61,11 +60,11 @@ Example:
61
60
```js
62
61
var s = "JavaScript syntax highlighting";
63
62
alert(s);
64
-
```
63
+
```
65
64
66
65
becomes:
67
66
68
-
```javascript
67
+
```javascript
69
68
var s ="JavaScript syntax highlighting";
70
69
alert(s);
71
70
```
@@ -94,8 +93,49 @@ The language of the code block always has to be specified by adding it right aft
94
93
| Shell | sh |
95
94
| Sass | sass |
96
95
96
+
To add a code block that doesn't need syntax highlighting use <code>```text</code>.
97
+
97
98
## How can I transfer existing content from a Google Doc?
98
99
99
100
The easiest way to convert content from a Google Doc to markdown is to use the following web tool: https://euangoddard.github.io/clipboard2markdown/
100
101
101
-
You can copy & paste your content and it will automagically be converted to markdown. The markdown still needs to be tidied up and the image links need to be adjusted to refer to the `assets` path.
102
+
You can copy & paste your content and it will automagically be converted to markdown. The markdown still needs to be tidied up and the image links need to be adjusted to refer to the `assets` path.
103
+
104
+
## Best Practices
105
+
See https://www.markdownguide.org/basic-syntax
106
+
107
+
### Heading Best Practices
108
+
109
+
Markdown applications don’t agree on how to handle missing blank lines between a heading and the surrounding paragraphs. For compatibility, separate paragraphs and headings with one or more blank lines.
110
+
111
+
✅ **Do this**
112
+
```
113
+
This is a paragraph.
114
+
115
+
# Here's the heading
116
+
117
+
And this is another paragraph.
118
+
```
119
+
120
+
❌ **Don't do this**
121
+
```
122
+
This is a paragraph.
123
+
# Here's the heading
124
+
And this is another paragraph.
125
+
```
126
+
127
+
### Paragraph Best Practices
128
+
129
+
Don’t indent paragraphs with spaces or tabs.
130
+
131
+
✅ **Do this**
132
+
```
133
+
Don't put tabs or spaces in front of your paragraphs.
134
+
Keep lines left-aligned like this.
135
+
```
136
+
137
+
❌ **Don't do this**
138
+
```
139
+
This can result in unexpected formatting problems.
0 commit comments