Here are some examples of basic Markdown syntax you can use when writing Markdown content in Astro.
Title
You should avoid creating duplicate article titles in the Markdown main body, as article titles are automatically
generated based on the title in frontmatter.
Avoid heading levels that are too deep, usually up to the third level of heading is enough.
First Class
Second Class
Third Class `inline code'
Fourth Class
Fifth Class
Sixth Class
Paragraphs
Use two spaces at the end of a line to make a line break within a paragraph
All work and no play makes Jack a dull boy.
All work and no play makes Jack a dull boy.
Pictures
Small Size Pictures
Large Size Pictures
Pictures with captions
Emphasizes
This is the important element and this is the secondary element.
Strikethrough
This is a deleted text.
Quote
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.
Tiam, ad mint andaepu dandae nostion secatur sequo quae.
Note that you can use Markdown syntax within a blockquote.
Nested references
quote
nested reference
References with footnotes
Don't communicate by sharing memory, share memory by communicating.
— Rob Pike1
Dividing Line
Links
This is the internal link Gyoza User Guide
This is the external link React Chinese documentation
Automatically rendered as a connection https://github.com
Email address [email protected]
Table
| Name | Age | Fruit |
|---|---|---|
| Bob | 27 | Apple |
| Alice | 23 | Banana |
| John | 28 | Orange |
Inline Markdown support
| Italics | Bold | Code |
|---|---|---|
| italics | bold | code |
Form Overflow
| A | B | C | D | E | F |
|---|---|---|---|---|---|
| Lorem ipsum dolor sit amet, consectetur adipiscing elit. | Phasellus ultricies, sapien non euismod aliquam, dui ligula tincidunt odio, at accumsan nulla sapien eget ex. | Proin eleifend dictum ipsum, non euismod ipsum pulvinar et. Vivamus sollicitudin, quam in pulvinar aliquam, metus elit pretium purus | Proin sit amet velit nec enim imperdiet vehicula. | Ut bibendum vestibulum quam, eu egestas turpis gravida nec | Sed scelerisque nec turpis vel viverra. Vivamus vitae pretium sapien |
Code Blocks
Syntax
we can use 3 backticks ``` in new line and write snippet and close with 3 backticks on new line and to highlight language specific syntac, write one word of language name after first 3 backticks, for eg. html, javascript, css, markdown, typescript, txt, bash
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Example HTML5 Document</title>
</head>
<body>
<p>Test</p>
</body>
</html>const var text = "hello world"KaTeX formulas
Use $ symbols to wrap formulas to generate in-line formulas, e.g. .
Use $$ symbol-wrapped formulas to generate standalone formulas. Example:
It is also possible to use the code block (```math) approach:
List Types
Ordered List
Syntax
1. First item
2. Second item
3. Third itemOutput
- First item
- Second item
- Third item
Unordered List
Syntax
- List item
- Another item
- And another itemOutput
- List item
- Another item
- And another item
Nested list
Syntax
- Fruit
- Apple
- Orange
- Banana
- Dairy
- Milk
- CheeseOutput
- Fruit
- Apple
- Orange
- Banana
- Dairy
- Milk
- Cheese
Other Elements — abbr, sub, sup, kbd, mark
Syntax
<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><kbd>CTRL</kbd>+<kbd>ALT</kbd>+<kbd>Delete</kbd></kbd> to end the session.
Most <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and other small creatures.Output
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.
Spoiler
||hide content||Under normal circumstances, this content will be hidden hide content and will only be shown when the mouse is hovered over.