Skip to content

Commit 24a0f83

Browse files
authored
Update styleguide.md (#68)
1 parent 3ee43d3 commit 24a0f83

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

styleguide.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
##### Heading h5
1111
###### Heading h6
1212
```
13+
1314
Note: h1 - h4 items will be automatically added to the Table of Contents.
1415

1516
## Emphasis
@@ -23,13 +24,15 @@ This is _italic text_.
2324
```
2425

2526
### Bold
27+
2628
Wrap text with double `**` for **Bold** text:
2729

2830
```md
2931
This is **bold text**.
3032
```
3133

3234
### Strikethrough
35+
3336
Wrap text with double `~~` for ~~strikethrough~~ text:
3437

3538
```md
@@ -79,6 +82,7 @@ Use numbered items followed by a `.:
7982
## Horizontal Rules
8083

8184
Use `---` for a horizontal rules:
85+
8286
```md
8387
---
8488
```
@@ -95,8 +99,9 @@ Use `---` for a horizontal rules:
9599

96100
### Inline Code
97101

98-
Wrap inline code with <code>`\``</code> backticks:
99-
````
102+
Wrap inline code with single <code>`\``</code> backticks:
103+
104+
````md
100105
```
101106
This is `inline code` wrapped with backticks
102107
```
@@ -107,7 +112,8 @@ When documenting an example, use the markdown <code>`\``</code> code block to de
107112
### Fenced Code Blocks
108113

109114
#### Javascript
110-
````
115+
116+
````md
111117
```javascript
112118
var foo = function (bar) {
113119
return bar++;
@@ -118,7 +124,8 @@ console.log(foo(5));
118124
````
119125

120126
#### JSON
121-
````
127+
128+
````md
122129
```json
123130
{
124131
"firstName": "John",
@@ -146,7 +153,8 @@ console.log(foo(5));
146153
````
147154

148155
#### CSS
149-
````
156+
157+
````md
150158
```css
151159
foo {
152160
padding: 5px;
@@ -160,7 +168,8 @@ foo {
160168
````
161169

162170
#### SCSS
163-
````
171+
172+
````md
164173
```scss
165174
foo {
166175
padding: 5px;
@@ -174,14 +183,16 @@ foo {
174183
````
175184

176185
#### HTML
177-
````
186+
187+
````md
178188
```html
179189
<span class="my-class">Example</span>
180190
```
181191
````
182192

183193
#### PHP
184-
````
194+
195+
````md
185196
```php
186197
$array = array(
187198
"foo" => "bar",
@@ -191,7 +202,8 @@ $array = array(
191202
````
192203

193204
#### Markdown
194-
````
205+
206+
````md
195207
```md
196208
This is _italic text_. This is **bold text**.
197209
```

0 commit comments

Comments
 (0)