Fading Coder

One Final Commit for the Last Sprint

Home > Tech > Content

Comprehensive Guide to Markdown Syntax and Usage

Tech 3

Markdown is a lightweight markup language designed for creating formatted documents using plain text. It is widely used for its readability and ease of conversion to formats like HTML. Below is a detailed overview of common Markdown elements with practical examples.

Headings

Headings are created by prefixing text with hash symbols (#). The number of hashes indicates the heading level, ranging from 1 (largest) to 6 (smallest).

# Primary Heading
## Secondary Heading
### Tertiary Heading
#### Quaternary Heading
##### Quinary Heading
###### Senary Heading

Paragraphs

Seperate paragraphs with a blank line to ensure proper formatting.

This is the initial paragraph.

This is the subsequent paragraph.

Text Emphasis

Use asterisks (*) or underscores (_) for italic text, double symbols for bold, and triple symbols for bold italic.

*Italicized text*
_Italicized text_

**Bold text**
__Bold text__

***Bold italic text***
___Bold italic text___

Strikethrough

Apply strikethrough using HTML tags or specific Markdown extensions.

<del>This text is struck through</del>

Lists

  • Unordered lists utilize asterisks (*), plus signs (+), or hyphens (-).
* First item
* Second item
    * Sub-item 2.1
    * Sub-item 2.2
  • Ordered lists employ numbers followed by periods.
1. Initial entry
2. Next entry
    1. Sub-entry 2.1
    2. Sub-entry 2.2

Links

Construct hyperlinks with the syntax [display text](URL).

Visit the [Markdown Guide](https://www.markdownguide.org) for more details.

Images

Embed images using ![alternative text](image URL).

![Sample illustration](https://www.example.com/picture.jpg)

Blockquotes

Indicate quoted content with a greater-than symbol (>).

> This is a quotation block.
>
> This is the second line within the same blockquote.

Code

  • Inline code is enclosde in backticks (`).
Execute the `print()` function to display output.
  • Code blocks are wrapped in triple backticks, optionally specifying a programming language.
function displayMessage() {
    console.log("Greetings!");
}

Tables

Create tables with pipes (|) too separate columns and hyphens (-) for the header row.

| Column A | Column B | Column C |
|----------|----------|----------|
| Entry 1  | Entry 2  | Entry 3  |
| Entry 4  | Entry 5  | Entry 6  |

Horizontal Rules

Insert a horizontal line with three or more hyphens (-), asterisks (*), or underscores (_).

---

Footnotes

Add footnotes using [^label] in the text and define them elsewhere.

This sentence includes a footnote reference[^1].

[^1]: Footnote explanation appears here.

Task Lists

Generate interactive checkboxes with - [ ] for incomplete tasks and - [x] for completed ones.

- [ ] Pending assignment
- [x] Finished assignment

HTML Integrasion

Markdown supports direct HTML embedding for advanced formatting.

This text includes <strong>bold</strong> HTML elements.

Example Document

Below is a sample Markdown document demonstrating the above syntax in a cohesive format.

# Sample Document

This document illustrates various Markdown features in practice.

## Lists

### Unordered List

* Item one
* Item two
    * Sub-item 2.1
    * Sub-item 2.2

### Ordered List

1. First point
2. Second point
    1. Sub-point 2.1
    2. Sub-point 2.2

## Links and Images

Access the [Markdown Guide](https://www.markdownguide.org) for resources.

![Example image](https://www.example.com/illustration.jpg)

## Blockquote

> This is a quoted section.
>
> It continues across multiple lines.

## Code

Use `console.log()` for debugging in JavaScript.

```python
def greet_user():
    print("Welcome!")

Table

Header 1 Header 2 Header 3
Data A Data B Data C
Data D Data E Data F

Horizontal Rule


Task List

  • Incomplete task
  • Completed task

Footnote

This text references a footnote[^1].

[^1]: Additional details provided here.

Tags: Markdown

Related Articles

Understanding Strong and Weak References in Java

Strong References Strong reference are the most prevalent type of object referencing in Java. When an object has a strong reference pointing to it, the garbage collector will not reclaim its memory. F...

Comprehensive Guide to SSTI Explained with Payload Bypass Techniques

Introduction Server-Side Template Injection (SSTI) is a vulnerability in web applications where user input is improper handled within the template engine and executed on the server. This exploit can r...

Implement Image Upload Functionality for Django Integrated TinyMCE Editor

Django’s Admin panel is highly user-friendly, and pairing it with TinyMCE, an effective rich text editor, simplifies content management significantly. Combining the two is particular useful for bloggi...

Leave a Comment

Anonymous

◎Feel free to join the discussion and share your thoughts.