¶ e2k Wiki
Updating .......
Updating .......
Updating .......
Updating .......
Updating .......
# Markdown Syntax Reference Document
This document demonstrates many of the common Markdown syntax elements along with examples for each. You can copy this text into a file (e.g., README.md) to see how Markdown renders it.
---
## Headings
You can create headings using the `#` symbol. The number of `#` symbols corresponds to the level of the heading.
```markdown
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
¶ Text Formatting
-
Bold text: Use double asterisks or underscores.
Example: This is bold and this is also bold
-
Italic text: Use single asterisks or underscores.
Example: This is italic and this is also italic
-
Inline code:Enclose text in backticks to format as inline code.Example:
print("Hello, world!") -
Strikethrough: Use double tildes to cross out text.Example:
This text has a strikethrough.
¶ Links and Images
¶ Inline Links
Create a hyperlink using square brackets for the link text and parentheses for the URL.
Example:
Google
¶ Reference-style Links
You can define links at the bottom of your document and reference them elsewhere.
Example:
This is an example of a [reference link][google].
Then later in the document, define it as:
[google]: https://www.google.com "Go to Google"
¶ Images
Images work similarly to links but with an exclamation mark at the start. You can also include alternative text and a title.
Example:
¶ Lists
¶ Unordered Lists
Use hyphens, asterisks, or plus signs for unordered lists.
- Item 1
- Item 2
- Sub-item 2a
- Sub-sub-item 2a-i
¶ Ordered Lists
Numbered lists can be created by preceding each line with a number followed by a period.
1. First item
2. Second item
1. Nested first item
2. Nested second item
3. Third item
¶ Blockquotes
Use the greater-than symbol (>) to create blockquotes. You can nest multiple paragraphs within a single blockquote.
> This is a blockquote.
>
> It can span multiple paragraphs.
>
> Each paragraph is separated by an empty line.
¶ Horizontal Rule
Create a horizontal rule using three or more hyphens, asterisks, or underscores.
---
***
___
¶ Code Blocks and Syntax Highlighting
Use triple backticks to create fenced code blocks. Optionally, specify the programming language for syntax highlighting.
Example with Python:
def greet(name):
print("Hello, " + name + "!")
greet("World")
Example with JavaScript:
console.log("Hello, world!");
¶ Tables
Tables are created using pipes (|) and dashes. The first row defines the headers.
| Feature | Description |
|-----------|---------------------|
| Bold | **Bold text** |
| Italic | *Italic text* |
| Code | `Inline code` example |
¶ Task Lists
Task lists can be created by using dashes, brackets, and an optional space.
- [x] Completed task
- [ ] Incomplete task
¶ Footnotes (Optional)
Some Markdown processors support footnotes. Here’s an example:
This is some text with a footnote reference.[1]
¶ Math Formulas (If Supported)
Inline math can be written using single dollar signs:
Example: ( E = mc^2 )
For display equations, use double dollar signs or backticks:
$$
\int_0^\infty e^{-x} \, dx = 1
$$
¶ Raw HTML
Markdown allows you to include raw HTML for more complex formatting.
Example:
¶ Conclusion
This document has covered many of the most common Markdown syntax elements. Experiment with these examples in your own documents and refer back here as needed.
Happy documenting!
This is the footnote content. ↩︎