Understanding Wiki Markdowns - ja-guzzle/guzzle_docs GitHub Wiki

• What Is Wiki Markdown?
• Headings Markdown
• Table of content Markdown
• Linebreak Markdown
• Italic Markdown
• Strong/Bold Markdown
• Strike-through Markdown
• Horizontal Rule Markdown
• Blockquote Markdown
• Links Markdown
• Image Markdown
• Unordered List Markdown
• Ordered List Markdown
• Paragraph Markdown
• Code Block Markdown
• Tables Markdown
• Task List Markdown

• Lightweight markup language with a plain text formatting syntax
• Can be converted into HTML and other formats using online converters
• It's main purpose is readability and ease of use during wiki documentations

• Start line with hash (#)

Example:
# Heading 1
## Heading 2

• Start wiki page with [ [_TOC_] ] and it will auto capture all headings markdown used in your page under the table of contents. Please note there is no space in between square brackets.

• End line with backslash (\)

• Start and end line with asterisk (*)
  *Write Your Text Here*
  Example:
  This is italic

• Start and end line with double asterisk (**)
  **Write Your Text Here**
  Example:
  This is bold

• Start and end line with double tilde (~~)
  ~~Write Your Text Here~~
  Example:
  This is strike-through

• Type triple dash only in a new line (---).

• Start line with greater than sign (>)

Example:

This is Quote!

• Write link display text enclosed within square brackets [] followed by web-link to be opened enclosed within parenthesis ()
  Example:
  Guzzle Parameters

• This is same as link markdown where square brackets start with exclamation ![] followed by image web-link enclosed within parenthesis (). Here web-link is nothing but web path for image to be displayed.
  Example:
  

• Start list item line with asterisk (*) followed by space which is followed by your text. For nested list, start line by hitting space twice followed by asterisk followed by space for nested list and rest is same.

Example:

• List Item 1
• List Item 2
  • Nested List Item 1

• Start each list item line with 1.

Example:

1. List Item 1
2. List Item 2
3. List Item 3

• Enclose text within `<p>Your text here</p>`.

Example: <p>This is paragraph.</p>

• Start line with triple backtick ``` followed by code block identifier like bash, python, java etc. End the code block by typing ``` at the end.

Example:

$cd /guzzle/conf

def add(num1, num2):
return num1 + num2

• Start each line with pipe, followed by space, followed by your text for column 1, followed by space and pipe, followed by your text for column 2 and so on to keep adding columns.

| Name | Designation |
|------|----------------------|
| Alex | Software Engineer |
| Bob | System Administrator |

Example:

• Start each line with asterisk followed by space followed by cross sign enclosed by square bracket [x].

Example:

• Task 1
• Task 2
• Task 3