Skip to main content

Markdown Introduction

About 1 minCookbookMarkdownIntroMarkdown

Markdown is a markup language that can be written using a plain text editor that allows plain text content to be formatted with simple markup syntax.

Markdown has a series of derivative versions that extend Markdown's functionality (such as tables, footnotes, embedded HTML, etc.). These features were not available in the original Markdown. They can convert Markdown into more formats, such as LaTeX, Docbook, Markdown Extra, MultiMarkdown, Maruku, etc. are more famous in Markdown's enhanced version. These derivative versions are either based on tools such as Pandoc; or based on sites such as GitHub and Wikipedia, which are syntactically compatible, but have some changes in syntax and rendering effects.

Usage

Markdown's grammar is simple and straightforward, easy to learn, and features more powerful than plain text, so people use it to write blogs. WordPress, the world's most popular blogging platform, and large CMSs such as Joomla and Drupal all support Markdown. The blog platforms that use the Markdown editor are Ghost and Typecho.

Used to write documentation and save it under the software's directory under the filename README.md. Because we have a god-level editor like RStudio, we can turn Markdown into a presentation PPT, Word product documentation, LaTex papers, and even a minimally usable prototype with little code. In the field of data science, Markdown has been widely used, greatly promoting the historical process of dynamic repeatability research.

ShortCut Key

DisplayCodeShortCut Key
Bold**text**Ctrl/⌘ + B
Emphasize*text*Ctrl/⌘ + I
Inline Code`code`Select then `

Title

The title shows the structure of the article. Insert 1-6 # at the beginning of the line, each adding a # indicates a more in-depth content, corresponding to the depth of the title by 1-6.

  • H1: # Header 1
  • H2: ## Header 2
  • H3: ### Header 3
  • H4: #### Header 4
  • H5: ##### Header 5
  • H6: ###### Header 6

Text Style

  • Link: [Title](URL)
  • Bold: **Bold**
  • Italic:*Italics*
  • Delete:~~Italics~~
  • Paragraph: Space one link
  • Line break: enter two space or \ at the end of the line
  • List: add - to become a list item
  • Blockquote: > Blockquote Content
  • HR: Enter --- in a single line

[Title](URL)

Example: [Baidu](https://baidu.com)

Image

![Alt](ImageLink)

E.g: ![This is a title](./assets/title.jpg).

Tables

centerrightleft
For center align use :-:For right align use -:For left align use :-
baaaaaaaaaaaaa
caaaaa

Emoji

:emoji name:

Example: :smile:

For full emoji list, see Emoji List.

Markdown Display