Skip to content

Commit 504950c

Browse files
authored
Add best practices section
1 parent 23d6352 commit 504950c

File tree

1 file changed

+45
-5
lines changed

1 file changed

+45
-5
lines changed

README.md

Lines changed: 45 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ Contributing by creating content or suggestion changes to existing content can b
99
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.
1010

1111

12-
1312
# How Do I Use Markdown to Write Content?
1413

1514
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
4443

4544
## How Can I Add Line Breaks?
4645

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.
4847
```
4948
This is the first line.
5049
And this is the second line.
@@ -61,11 +60,11 @@ Example:
6160
```js
6261
var s = "JavaScript syntax highlighting";
6362
alert(s);
64-
```
63+
```
6564

6665
becomes:
6766

68-
```javascript
67+
```javascript
6968
var s = "JavaScript syntax highlighting";
7069
alert(s);
7170
```
@@ -94,8 +93,49 @@ The language of the code block always has to be specified by adding it right aft
9493
| Shell | sh |
9594
| Sass | sass |
9695

96+
To add a code block that doesn't need syntax highlighting use <code>```text</code>.
97+
9798
## How can I transfer existing content from a Google Doc?
9899

99100
The easiest way to convert content from a Google Doc to markdown is to use the following web tool: https://euangoddard.github.io/clipboard2markdown/
100101

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.
140+
Don't add tabs or spaces in front of paragraphs.
141+
```

0 commit comments

Comments
 (0)