Skip to content

Update styleguide.md #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 2, 2022
Merged

Update styleguide.md #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions styleguide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
##### Heading h5
###### Heading h6
```

Note: h1 - h4 items will be automatically added to the Table of Contents.

## Emphasis
Expand All @@ -23,13 +24,15 @@ This is _italic text_.
```

### Bold

Wrap text with double `**` for **Bold** text:

```md
This is **bold text**.
```

### Strikethrough

Wrap text with double `~~` for ~~strikethrough~~ text:

```md
Expand Down Expand Up @@ -79,6 +82,7 @@ Use numbered items followed by a `.:
## Horizontal Rules

Use `---` for a horizontal rules:

```md
---
```
Expand All @@ -95,8 +99,9 @@ Use `---` for a horizontal rules:

### Inline Code

Wrap inline code with <code>`\``</code> backticks:
````
Wrap inline code with single <code>`\``</code> backticks:

````md
```
This is `inline code` wrapped with backticks
```
Expand All @@ -107,7 +112,8 @@ When documenting an example, use the markdown <code>`\``</code> code block to de
### Fenced Code Blocks

#### Javascript
````

````md
```javascript
var foo = function (bar) {
return bar++;
Expand All @@ -118,7 +124,8 @@ console.log(foo(5));
````

#### JSON
````

````md
```json
{
"firstName": "John",
Expand Down Expand Up @@ -146,7 +153,8 @@ console.log(foo(5));
````

#### CSS
````

````md
```css
foo {
padding: 5px;
Expand All @@ -160,7 +168,8 @@ foo {
````

#### SCSS
````

````md
```scss
foo {
padding: 5px;
Expand All @@ -174,14 +183,16 @@ foo {
````

#### HTML
````

````md
```html
<span class="my-class">Example</span>
```
````

#### PHP
````

````md
```php
$array = array(
"foo" => "bar",
Expand All @@ -191,7 +202,8 @@ $array = array(
````

#### Markdown
````

````md
```md
This is _italic text_. This is **bold text**.
```
Expand Down