Matthew Lang avatar

Matthew Lang

Family guy and web developer

Styleguide

Markdown Style Guide for Blogging

This document serves as a comprehensive reference for writing blog posts using Markdown, including GitHub’s extended Markdown features.


1. Headings

Use # symbols for headings. Always follow a logical structure.

# H1: Blog name
### H2: Title of posts and pages
### H3: Major sections
#### H4: Minor sections
##### H5: Rarely used subsections
###### H6: Almost never used subsections

Rendered:

H1: Blog name

H2: Title of posts and pages

H3: Major sections

H4: Minor sections

H5: Rarely used subsections
H6: Almost never used subsections

2. Emphasis

  • Bold: Use double asterisks (**) or underscores (__).
  • Italic: Use single asterisks (*) or underscores (_).
  • Bold and italic: Combine triple asterisks (***) or underscores.
**Bold Text**
*Italic Text*
***Bold and Italic Text***

3. Lists

Unordered List

Use -, *, or + for unordered lists.

- Item 1
  - Sub-item 1.1
  - Sub-item 1.2
- Item 2

Ordered List

Use numbers followed by a period (1.).

1. Step 1
2. Step 2
   1. Sub-step 2.1
   2. Sub-step 2.2

  • Inline: [Text](URL)
  • Reference-style:
[GitHub](https://github.com)
[Example][1]

[1]: https://example.com

5. Images

  • Inline: ![Alt text](URL)
  • Reference-style:
![Alt text](https://via.placeholder.com/150)
![Alt text][img-ref]

[img-ref]: https://via.placeholder.com/150

6. Blockquotes

Use > to indicate blockquotes. Nest by adding multiple > symbols.

> This is a blockquote.
>> Nested blockquote.

7. Code Blocks

Inline Code

Use backticks (`) for inline code.

Here is some `inline code`.

Here is some inline code.

Specify the language for syntax highlighting.


```javascript
const example = "Hello World";
console.log(example);

Rendered:

```javascript
const example = "Hello World";
console.log(example);

8. Tables

Use | and - to create tables.

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Row 1    | Data     | Value    |
| Row 2    | Data     | Value    |

Rendered:

Header 1 Header 2 Header 3
Row 1 Data Value
Row 2 Data Value

10. Horizontal Rules

Use ---, ***, or ___.

---
***
___


15. Collapse Sections

Use the <details> and <summary> tags to create collapsible sections.

<details>
  <summary>Click to expand</summary>

  Hidden content here.

</details>
Click to expand Hidden content here.

16. Glossary

Term
: Definition for the term.

This guide ensures clarity and consistency when writing blog posts in Markdown. Use it as a reference to maintain high-quality content!