hero image

Markdown Style Guide

2 年前
2 分鐘
約 498 字

Here is a sample of some basic Markdown syntax that can be used when writing Markdown content in Astro.

HeadingsH2

The following HTML <h1><h6> elements represent six levels of section headings. <h1> is the highest section level while <h6> is the lowest.

H1H1

H2H2

H3H3

H4H4

H5H5
H6H6

ParagraphH2

Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat.

Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.

ImagesH2

SyntaxH3

markdown
![Alt text](./full/or/relative/path/of/image)

OutputH3

BlockquotesH2

The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a footer or cite element, and optionally with in-line changes such as annotations and abbreviations.

Blockquote without attributionH3

SyntaxH4

markdown
> Tiam, ad mint andaepu dandae nostion secatur sequo quae.  
> **Note** that you can use _Markdown syntax_ within a blockquote.

OutputH4

Tiam, ad mint andaepu dandae nostion secatur sequo quae.
Note that you can use Markdown syntax within a blockquote.

Blockquote with attributionH3

SyntaxH4

markdown
> Don't communicate by sharing memory, share memory by communicating.<br />
><cite>Rob Pike[^1]</cite>

OutputH4

Don’t communicate by sharing memory, share memory by communicating.
Rob Pike1

TablesH2

SyntaxH3

markdown
| Italics   | Bold     | Code   |
| --------- | -------- | ------ |
| _italics_ | **bold** | `code` |

OutputH3

ItalicsBoldCodeItalicsBoldCode
italicsboldcodeitalicsboldcode

Code BlocksH2

SyntaxH3

we can use 3 backticks ``` in new line and write snippet and close with 3 backticks on new line and to highlight language specific syntax, write one word of language name after first 3 backticks, for eg. html, javascript, css, markdown, typescript, txt, bash

markdown
```html
<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>Example HTML5 Document</title>
  </head>
  <body>
    <p>Test</p>
  </body>
</html>
```

OutputH3

html
<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>Example HTML5 Document</title>
  </head>
  <body>
    <p>Test</p>
  </body>
</html>

List TypesH2

Ordered ListH3

SyntaxH4

markdown
1. First item
2. Second item
3. Third item

OutputH4

  1. First item
  2. Second item
  3. Third item

Unordered ListH3

SyntaxH4

markdown
- List item
- Another item
- And another item

OutputH4

  • List item
  • Another item
  • And another item

Nested listH3

SyntaxH4

markdown
- Fruit
  - Apple
    - Orange
    - Banana
- Dairy
  - Milk
  - Cheese

OutputH4

  • Fruit
    • Apple
      • Orange
      • Banana
  • Dairy
    • Milk
    • Cheese

Other Elements — abbr, sub, sup, kbd, markH2

SyntaxH3

markdown
<abbr title="Graphics Interchange Format">GIF</abbr> is a bitmap image format.

H<sub>2</sub>O

X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>

Press <kbd>CTRL</kbd> + <kbd>ALT</kbd> + <kbd>Delete</kbd> to end the session.

Most <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and other small creatures.

OutputH3

GIF is a bitmap image format.

H2O

Xn + Yn = Zn

Press CTRL + ALT + Delete to end the session.

Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures.

FootnotesH2

  1. The above quote is excerpted from Rob Pike’s talk during Gopherfest, November 18, 2015.

tantuyu. :)