markdown

 online editor 

https://dillinger.io/

https://stackedit.io/

extension : .md or .markdown

markdown processor (parser)  converts markdown to html

for website:

https://blot.im/

https://jekyllrb.com/ + github pages

https://jamstack.org/generators/

cms : https://ghost.org/

 

Basic Syntax

 

Heading 

# Heading level 1  <h1>Heading level 1</h1>

## h2, ### h3 up to ###### h6

on the line below the text, add any number of == characters for heading level 1 or -- characters for heading level 2.

For compatibility, 

always put a space between the number signs and the heading name.

You should also put blank lines before and after a heading 

 

Paragraph

use blank lines

don’t indent paragraphs with spaces or tabs  unless in list

 

Line Breaks

 end a line with two or more spaces, and then type return.

 

Bold

two asterisks or underscores before and after a word or phrase. To bold the middle of a word for emphasis, add two asterisks without spaces around the letters.

For compatibility, use asterisks to bold the middle of a word for emphasis.

 

Italic

one  asterisk/underscore like bold

 

Bold and Italic

three asterik/underscore

 

Blockquotes

 add a > in front of a paragraph.

Blockquotes with Multiple Paragraphs

Add a > on the blank lines between the paragraphs.

 

Nested Blockquotes

 Add a >> in front of the paragraph you want to nest.

 

For compatibility, put blank lines before and after blockquotes.

 

Ordered Lists

 add line items with numbers followed by periods.he numbers don’t have to be in numerical order, but the list should start with the number one.

 

Unordered Lists

To create an unordered list, add dashes (-), asterisks (*), or plus signs (+) in front of line items. Indent one or more items to create a nested list.

 

For compatibility : don’t mix and match delimiters in the same list — pick one and stick with it.

 

Adding Elements in Lists

 To add another element in a list while preserving the continuity of the list, indent the element four spaces or one tab

 

Code Blocks

 indented four spaces or one tab. When they’re in a list, indent them eight spaces or two tabs.

 

Images 

To add an image, add an exclamation mark (!), followed by alt text in brackets, and the path or URL to the image asset in parentheses. You can optionally add a title in quotation marks after the path or URL.

    ![alt text](/path/to/image/file.extension "image title" )

Code 


To denote a word or phrase as code, enclose it in backticks (`).

Escaping Backticks

escape it by enclosing the word or phrase in double backticks (``).

Code Blocks

To create code blocks, indent every line of the block by at least four spaces or one tab.

 

Horizontal Rules

 use three or more asterisks (***), dashes (---), or underscores (___) on a line by themselves.

 

For compatibility, put blank lines before and after horizontal rules.

 

Links

 link text in brackets [] follow it immediately with the URL in parentheses ()

[link text](https://google.com)

Adding Titles

 title for a link. This will appear as a tooltip when the user hovers over the link. To add a title, enclose it in quotation marks after the URL

 

My favorite search engine is [Duck Duck Go](https://duckduckgo.com "The best search engine for privacy").

URLs and Email Addresses

To quickly turn a URL or email address into a link, enclose it in angle brackets.

<https://www.markdownguide.org>
<[email protected]> 

Formatting Links

 add asterisks before and after the brackets and parentheses. To denote links as code, add backticks in the brackets.

 

Reference-style Links

 Reference-style links are a special kind of link that make URLs easier to display and read in Markdown. Reference-style links are constructed in two parts: the part you keep inline with your text and the part you store somewhere else in the file to keep the text easy to read.

Formatting the First Part of the Link

wo sets of brackets. The first set of brackets surrounds the text that should appear linked. The second set of brackets displays a label used to point to the link you’re storing elsewhere in your document.

Formatting the Second Part of the Link

1. The label, in brackets, followed immediately by a colon and at least one space (e.g., [label]: ).
2. The URL for the link, which you can optionally enclose in angle brackets.
3. The optional title for the link, which you can enclose in double quotes, single quotes, or parentheses.

 

An Example Putting the Parts Together

In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, filled with the ends
of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to
eat: it was a [hobbit-hole][1], and that means comfort.

[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> "Hobbit lifestyles"

For compatibility, try to URL encode any spaces with %20.

Linking Images

  enclose the Markdown for the image in brackets, and then add the link in parentheses.

[![An old rock in the desert](https://live.staticflickr.com/389/31833779864_38b5c9d52e_z.jpg "Shiprock, New Mexico by Beau Rogers")](https://www.flickr.com/photos/beaurogers/31833779864/in/photolist-Qv3rFw-34mt9F-a9Cmfy-5Ha3Zi-9msKdv-o3hgjr-hWpUte-4WMsJ1-KUQ8N-deshUb-vssBD-6CQci6-8AFCiD-zsJWT-nNfsgB-dPDwZJ-bn9JGn-5HtSXY-6CUhAL-a4UTXB-ugPum-KUPSo-fBLNm-6CUmpy-4WMsc9-8a7D3T-83KJev-6CQ2bK-nNusHJ-a78rQH-nw3NvT-7aq2qf-8wwBso-3nNceh-ugSKP-4mh4kh-bbeeqH-a7biME-q3PtTf-brFpgb-cg38zw-bXMZc-nJPELD-f58Lmo-bXMYG-bz8AAi-bxNtNT-bXMYi-bXMY6-bXMYv) 

Escaping Characters

add a backslash (\) in front of the character.

 

summary

Heading	# H1 ## H2 ### H3
Bold	**bold text**
Italic	*italicized text*
Blockquote	> blockquote
Ordered List	1. First item 2. Second item 3. Third item
Unordered List	- First item - Second item - Third item
Code	`code`
Horizontal Rule	---
Link	[title](https://www.example.com)
Image	

 

src:

https://www.markdownguide.org/getting-started/