Comprehensive Guide to Markdown Document Authoring
Markdown is a lightweight markup language that allows users to format plain text documents. Its design prioritizes readability and ease of writing, with straightforward conversion capabilities to formats like HTML. This guide details common Markdown syntax with practical examples.
This text inclueds a footnote1.
Headings Headings are created using the hash symbol (#). The number of hashes denotes the heading level, ranging from 1 (most prominent) to 6 (least prominent).
# Heading Level 1
## Heading Level 2
### Heading Level 3
#### Heading Level 4
##### Heading Level 5
###### Heading Level 6
Paragraphs Separate paragraphs by inserting a blank line between them.
This is the first paragraph.
This is the second paragraph.
Emphasis Apply emphasis using asterisks (*) or underscores (_). Italicize text by enclosing it with a single pair, bold text with double pairs, and bold-italic text with triple pairs.
*Italic text*
_Italic text_
**Bold text**
__Bold text__
***Bold-Italic text***
___Bold-Italic text___
Strikethrough This text is struck through.
Lists Unordered Lists Use asterisks (*), plus signs (+), or hyphens (-) to create bullet points. Indentation creates nested lists.
* Item 1
* Item 2
* Sub-item 2.1
* Sub-item 2.2
Ordered Lists Use numbers followed by a period (.) for numbered lists. Indentation creates nested ordered lists.
1. First item
2. Second item
1. Sub-item 2.1
2. Sub-item 2.2
Links Create hyperlinks using the following syntax: [Display Text](URL).
This is a link to the [Markdown Guide](https://www.markdownguide.org).
Images Insert images using the following syntax: .
Blockquotes Use the greater-than symbol (>) to denote blockquotes. Multiple lines or paragraphs within a quote are indicated by additional greater-than symbols or blank lines.
> This is a blockquote.
>
> This is a second paragraph within the same blockquote.
Code Formatting Inline Code Enclose inline code snippets using backticks (`).
This is an `inline code` example.
Code Blocks Use triple backticks (```) to define code blocks. You can optionally specify the programming language for syntax highlighting.
```python
def greet(name):
print(f"Hello, {name}!")
Tables Construct tables using pipes (|) to separate columns and hyphens (-) to separate the header row from the body.
| Header 1 | Header 2 | Header 3 |
| -------- | -------- | -------- |
| Row 1, Col 1 | Row 1, Col 2 | Row 1, Col 3 |
| Row 2, Col 1 | Row 2, Col 2 | Row 2, Col 3 |
Horizontal Rules Insert horizontal rules using three or more hyphens (-), asterisks (*), or underscores (_).
---
Footnotes Add footnotes by using a caret bracket reference like [^1] and defining the footnote content later.
This text has a footnote.[^1]
[^1]: This is the content of the footnote.
This text has a footnote1.
Task Lists Create task lists using hyphens followed by brackets. Use [ ] for incomplete tasks and [x] for completed tasks.
- [ ] Incomplete task
- [x] Completed task
Embedded HTML Markdown allows direct embedding of HTML tags.
This is an <b>HTML bold</b> example.
Sample Markdown Document The following demonstrates the application of various Markdown elements.
# Sample Document
This document illustrates the usage of diverse Markdown syntax.
## Lists
### Unordered
* Element A
* Element B
* Sub-element B.1
* Sub-element B.2
### Ordered
1. Step One
2. Step Two
1. Sub-step 2.1
2. Sub-step 2.2
## Links and Images
Visit the [official Markdown documentation](https://www.markdownguide.org).
## Quotations
> This is a sample quotation block.
>
> It can span multiple lines and paragraphs.
## Code Snippets
Here's an example of `inline code`.
```javascript
function sayHello(message) {
console.log(message);
}
Table Example
| Column Alpha | Column Beta | Column Gamma |
|---|---|---|
| Data A1 | Data B1 | Data C1 |
| Data A2 | Data B2 | Data C2 |
Separator
Task List Example
- Task Pending
- Task Completed
Footnote Reference This is a footnote reference1.
- This is the footnote's descriptive content. ↩︎
