December 8, 2024

Test

标题

在标题文字前使用 1 到 6 个 # 符号生成标题。其数量决定了标题的级别与字号大小。

# 一级标题
 
## 二级标题
 
### 三级标题
 
#### 四级标题
 
##### 五级标题
 
###### 六级标题

文本样式

样式语法示例Output
粗体** ****粗体**粗体
斜体_ __斜体_斜体
删除线~~ ~~~~删除线~~删除线
粗体嵌套斜体** **_ _**粗体 _嵌套_ 斜体**粗体 嵌套 斜体
粗斜体**_ _****_粗斜体_**粗斜体
下标<sub> </sub>下<sub>标</sub>
上标<sup> </sup>上<sup>标</sup>
下划线<ins> </ins><ins>下划线</ins>下划线

引用

使用 > 引用文字

> 引用的文本具有不同的样式

引用的文本具有不同的样式

代码

使用一对反引号标注代码或命令行,反引号内的文本不会被格式化。

使用 `git status` 列出所有尚未提交的新文件或修改过的文件

结果:

使用 git status 列出所有尚未提交的新文件或修改过的文件

可以在末尾如下高亮语言:

使用 `git status{:bash}` 列出所有尚未提交的新文件或修改过的文件

结果:

使用 git status 列出所有尚未提交的新文件或修改过的文件

代码块

使用三对反引号包裹代码块,可以在反引号后指定代码语言,以实现代码高亮。

```bash
git status
git add
git commit
```

结果:

git status
git add
git commit

若代码块内部需要包含代码块,可以使用四对反引号。

若需要高亮行号,可以在反引号后指定行号。

```bash {1-2,3}
git status
git add
git commit
```

结果:

git status
git add
git commit

若要显示行号, 可以在反引号后指定 showLineNumbers

```bash showLineNumbers
git status
git add
git commit
```

结果:

git status
git add
git commit

链接

You can create an inline link by wrapping link text in brackets [ ], and then wrapping the URL in parentheses ( ). You can also use the keyboard shortcut K to create a link. When you have text selected, you can paste a URL from your clipboard to automatically create a link from the selection.

This site was built using [GitHub Pages](https://pages.github.com).

列表

You can make an unordered list by preceding one or more lines of text with -, *, or +.

- George Washington
 
* John Adams
 
- Thomas Jefferson
  • George Washington
  • John Adams
  • Thomas Jefferson

To order your list, precede each line with a number.

1. James Madison
2. James Monroe
3. John Quincy Adams
  1. James Madison
  2. James Monroe
  3. John Quincy Adams

嵌套列表

You can create a nested list by indenting one or more list items below another item.

To create a nested list using the web editor on or a text editor that uses a monospaced font, like Visual Studio Code, you can align your list visually. Type space characters in front of your nested list item until the list marker character (- or *) lies directly below the first character of the text in the item above it.

1. First list item
   - First nested list item
     - Second nested list item
  1. First list item
    • First nested list item
      • Second nested list item

To create a nested list in the comment editor on , which doesn't use a monospaced font, you can look at the list item immediately above the nested list and count the number of characters that appear before the content of the item. Then type that number of space characters in front of the nested list item.

In this example, you could add a nested list item under the list item 100. First list item by indenting the nested list item a minimum of five spaces, since there are five characters (100. ) before First list item.

100. First list item
     - First nested list item
  1. First list item
    • First nested list item

You can create multiple levels of nested lists using the same method. For example, because the first nested list item has seven characters (␣␣␣␣␣-␣) before the nested list content First nested list item, you would need to indent the second nested list item by at least two more characters (nine spaces minimum).

100. First list item
     - First nested list item
       - Second nested list item
  1. First list item
    • First nested list item
      • Second nested list item

For more examples, see the GitHub Flavored Markdown Spec.

任务清单

To create a task list, preface list items with a hyphen and space followed by [ ]. To mark a task as complete, use [x].

- [x] #739
- [ ] https://github.com/octo-org/octo-repo/issues/740
- [ ] Add delight to the experience when all tasks are complete 🎉

段落

You can create a new paragraph by leaving a blank line between lines of text.

脚注

You can add footnotes to your content by using this bracket syntax:

Here is a simple footnote[^1].
 
A footnote can also have multiple lines[^2].
 
[^1]: My reference.
 
[^2]:
    To add line breaks within a footnote, prefix new lines with 2 spaces.
    This is a second line.

The footnote will render like this:

Here is a simple footnote1.

A footnote can also have multiple lines2.

The position of a footnote in your Markdown does not influence where the footnote will be rendered. You can write a footnote right after your reference to the footnote, and the footnote will still render at the bottom of the Markdown. Footnotes are not supported in wikis.

Alerts

We using MDX NextUI component to implement Alerts.

Use alerts only when they are crucial for user success and limit them to one or two per article to prevent overloading the reader. Additionally, you should avoid placing alerts consecutively. Alerts cannot be nested within other elements.

To add an alert, use a special blockquote line specifying the alert type, followed by the alert information in a standard blockquote. Six types of alerts are available:

<Alert
  title={'Default Style'}
  description={'Some normal information content.'}
/>
 
<Alert
  color={'primary'}
  title={'Primary Style'}
  description={
    'Useful information that users should know, even when skimming content.'
  }
/>
 
<Alert
  color={'secondary'}
  title={'Secondary Style'}
  description={'Helpful advice for doing things better or more easily.'}
/>
 
<Alert color={'success'} title={'Success Style'} description={'We did it!'} />
 
<Alert
  color={'warning'}
  title={'Warning Style'}
  description={
    'Urgent info that needs immediate user attention to avoid problems.'
  }
/>
 
<Alert
  color={'danger'}
  title={'Danger Style'}
  description={'Advises about risks or negative outcomes of certain actions.'}
/>

注释

You can tell to hide content from the rendered Markdown by placing the content in an HTML comment.

{/* This content will not appear in the rendered Markdown */}

Result:

Yes, the content is hidden.

Ignoring Markdown formatting

You can tell to ignore (or escape) Markdown formatting by using \ before the Markdown character.

Let's rename \*our-new-project\* to \*our-old-project\*.

Let's rename *our-new-project* to *our-old-project*.

For more information on backslashes, see Daring Fireball's "Markdown Syntax."

The Markdown formatting will not be ignored in the title of an issue or a pull request.

Footnotes

  1. My reference.

  2. To add line breaks within a footnote, prefix new lines with 2 spaces. This is a second line.