Markdown
Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).
Documentation: Markdown Docs RFC: RFC 7763 GitHub Documentation: Writing Markdown on GitHub
Headings
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Here is a heading: # Heading
, don't do this: #Heading
Emphasis
Emphasis, aka italics, with *asterisks* or _underscores_.
Strong emphasis, aka bold, with **asterisks** or __underscores__.
Combined emphasis with **asterisks and _underscores_**.
Strikethrough uses two tildes. ~~Scratch this.~~
Line Breaks
First line with two spaces after.
And the next line.
Break page
Insert this block where you want to create a page break.
<div style="page-break-after: always; break-after: page;"></div>
Lists
Ordered Lists
1. First item
2. Second item
3. Third item
Unordered Lists
- First item
- Second item
- Third item
Links
Link with text: [link-text](https://www.google.com)
Images
Image with alt text: ![alt-text](https://camo.githubusercontent.com/4d89cd791580bfb19080f8b0844ba7e1235aa4becc3f43dfd708a769e257d8de/68747470733a2f2f636e642d70726f642d312e73332e75732d776573742d3030342e6261636b626c617a6562322e636f6d2f6e65772d62616e6e6572342d7363616c65642d666f722d6769746875622e6a7067)
Image without alt text: ![](https://camo.githubusercontent.com/4d89cd791580bfb19080f8b0844ba7e1235aa4becc3f43dfd708a769e257d8de/68747470733a2f2f636e642d70726f642d312e73332e75732d776573742d3030342e6261636b626c617a6562322e636f6d2f6e65772d62616e6e6572342d7363616c65642d666f722d6769746875622e6a7067)
Position
List of avail positions :
Name | Description |
---|---|
left | Left align data, left justify text. |
center | Center align data, center justify text. |
right | Right align data, right justify text. |
justify | Double justify text. |
<p align="center">
<img src="images/img">
</p>}
Size
Use as %
width="1..100%"
<p align="center">
<img src="images/img" width="35%">
</p>
Code Blocks
Inline Code Block
Inline `code` has `back-ticks around` it.
Blocks of Code
var s = "JavaScript syntax highlighting"; alert(s);
s = "Python syntax highlighting" print s
No language indicated, so no syntax highlighting. But let's throw in a <b>tag</b>.
Tables
There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily.
Basic table Code :
| Syntax | Description | Test Text |
| :--- | :----: | ---: |
| Header | Title | Here's this |
| Paragraph | Text | And more |
Result : | Syntax | Description | Test Text | | :--- | :----: | ---: | | Header | Title | Here's this | | Paragraph | Text | And more |
Task list
To create a task list start line with square brackets with an empty space.
Ex: [
[x] Write the post
[ ] Update the website
[ ] Contact the user
Rules
This document contains a description of all rules, what they are checking for, as well as an examples of documents that break the rule and corrected versions of the examples.
Alerts
> [!NOTE]
> Useful information that users should know, even when skimming content.
> [!TIP]
> Helpful advice for doing things better or more easily.
> [!IMPORTANT]
> Key information users need to know to achieve their goal.
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.