Markdown

Markdown#

What is Markdown?#

Markdown is a lightweight markup language designed to format plain text efficiently. It is widely used for documentation, writing README files, and creating content for web applications such as Jupyter Notebooks, GitHub, and blogs.

Why Use Markdown?#

  • Simple and easy to learn: Uses human-readable syntax.

  • Lightweight: No special software required, just a plain text editor.

  • Widely supported: Used in GitHub, Jupyter, and documentation platforms like MkDocs.

  • Flexible: Can be converted to HTML, PDF, and other formats.

  • Enhances productivity: Streamlines writing and formatting for technical and non-technical users alike.

Useful VS Code Extensions#

  • Markdown All in One: Provides shortcuts, live preview, and enhanced editing features.

  • Markdown Shortcuts: Keyboard shortcuts for common Markdown tasks.

  • Prettier - Code formatter: Formats Markdown files for consistency.

  • Markdown PDF: Converts Markdown to PDF, HTML, and other formats.

Keyboard Shortcuts#

  • Ctrl + K + V: Preview Markdown.

  • Ctrl + B: Bold text.

  • Ctrl + I: Italicize text.

  • Ctrl + L: Create a hyperlink.

Basic Markdown Syntax#

1. Headings#

Use # for headings:

# Heading 1

## Heading 2

### Heading 3

#### Heading 4

##### Heading 5

###### Heading 6

2. Emphasis#

Use * or _ for italic, and ** or __ for bold:

*Italic* or _Italic_
**Bold** or __Bold__

3. Lists#

Unordered List#

Use -, *, or + for bullet points:

- Item 1
- Item 2
  - Sub-item 1
  - Sub-item 2

Ordered List#

Use numbers followed by a period:

1. First item
2. Second item
   1. Sub-item 1
   2. Sub-item 2

5. Images#

![GeoSoft Design](https://assets.gishub.org/images/geosoft-design.webp)

GeoSoft Design

![zootopia](https://i.imgur.com/ZBwwcjo.gif)

zootopia

6. Code Blocks#

Inline Code#

Use backticks:

`print("Hello, World!")`

Block Code#

Use triple backticks:

Markdown:

This is a markdown block

Text:

This is a text block.

Python:

print("Hello, World!")

Bash:

echo "Hello, World!"

7. Blockquotes#

Use >:

> This is a blockquote.

8. Tables#

| Column 1 | Column 2 | Column 3 |
| -------- | -------- | -------- |
| Data 1   | Data 2   | Data 3   |
| Data A   | Data B   | Data C   |

9. Horizontal Rule#

Use three ---, ***, or ___:

---

10. Task Lists (GitHub Flavored Markdown)#

- [x] Task 1
- [ ] Task 2
- [ ] Task 3

11. Strikethrough#

Use ~~ to strike through text:

~~This is struck-through text.~~

~~This is struck-through text.~~

12. Inline HTML#

Use inline HTML for additional customization:

<div style="color:red;">This text is red.</div>
This text is red.

Conclusion#

Markdown is a simple yet powerful way to format text. Mastering it will help you write better documentation, create well-structured notes, and collaborate effectively on platforms like GitHub and Jupyter Notebooks. By leveraging Markdown’s full feature set, you can enhance productivity and streamline content creation.

Contents