Notes/Computer Science/Markdown Syntax Reference

Markdown Syntax Reference

1 min#web

1. Headings

# Level 1 Heading
## Level 2 Heading
### Level 3 Heading
#### Level 4 Heading
##### Level 5 Heading
###### Level 6 Heading

Note: It is recommended to leave a space between # and the heading text.

2. Paragraphs and Line Breaks

  • Paragraphs: Write continuous text directly, separating paragraphs with blank lines.
  • Line breaks: Add two spaces at the end of a line before pressing Enter, or use <br>.

3. Emphasis

EffectSyntax
Bold**Bold** or __Bold__
Italic*Italic* or _Italic_
Bold italic***Bold italic***
Strikethrough~~Strikethrough~~
Underline<u>Underline</u>

4. Lists

Unordered Lists

- Item 1
- Item 2
  - Subitem (indent by 2 or 4 spaces)
* An asterisk also works
+ A plus sign also works

Ordered Lists

1. First item
2. Second item
   3. Subitem (indented)
4. Third item

Task Lists

- [x] Completed
- [ ] Incomplete
- [ ] To do
[Display text](https://example.com)
[Link with a title](https://example.com "Shown on hover")

Images

![Alternative text](https://example.com/image.jpg)
![Image](img.png "Optional title")
[Text][id]
[id]: https://example.com

6. Blockquotes

> This is a blockquote
> A blockquote spanning multiple lines
>> A nested blockquote

7. Code

Inline Code

`console.log('hello')`

Fenced Code Blocks

```python
print("Hello")
```

Specify a language such as python, javascript, or bash to enable syntax highlighting.

Indented Code Blocks (4 Spaces or 1 Tab Before Each Line)

    def hello():
        print("Hi")

8. Tables

| Left-aligned | Center-aligned | Right-aligned |
| :----------- | :------------: | ------------: |
| Content      |    Content     |       Content |
| Row 2        |     Row 2      |         Row 2 |

--- separates the header row, while : controls the alignment direction.

9. Horizontal Rules

---
***
___

Place at least three symbols on a line by themselves.

10. Escaping Characters

Use a backslash \ to escape special Markdown characters:

\* Not italic
\# Not a heading
\[ Not a link

11. HTML Tags (Extension)

Most Markdown renderers support inline HTML for more complex layouts:

<span style="color:red">Red text</span>
<br> Line break
<kbd>Ctrl</kbd> + <kbd>C</kbd>

12. Other Common Extensions (Platform-Dependent)

1. Footnotes

Text with a footnote[^1]
[^1]: Footnote content

2. Definition Lists

Term
: Definition

3. Collapsible/Details Blocks (GitHub)

<details>
<summary>Click to expand</summary>
Hidden content
</details>

4. Mathematical Formulas (Requires LaTeX)

Inline formula: $E=mc^2$
Block formula: $$x = \frac{-b}{2a}$$

5. Highlighting

==Highlighted text==

6. Subscripts and Superscripts

H~2~O      (subscript)
X^2^       (superscript)

13. Complete Example (Combined)

# Project Description

> **Important**: Install the dependencies first.

1. Clone the repository
   `git clone xxx`

2. Install the dependencies
   - [x] npm install
   - [ ] Configure environment variables

| Parameter | Description |
|-----------|-------------|
| `--port` | Port number; defaults to `3000` |

Comments