贡献指南速查表

学习目标

理解 Run 3 Starterkit 中使用的 Markdown 语法
掌握如何将 Run 2 风格的 Markdown 转换为 Run 3 语法
了解这些课程中使用的标准规范

以下列出了如何在课程中添加各种非标准 Markdown元素的说明，例如提示框和 $\LaTeX$ 。此外，还列出了旧版 Starterkit课程中相关内容的语法，供您从旧版课程转换内容时参考。

提示框（Admonitions）

提示框也称为强调框，是与其他文本有所区别的文本块。其编写语法如下：

新风格旧版Starterkit风格

!!! abstract "Learning Objectives"
    The learning objectives block is now separated by four spaces (exactly).

Normal text will resume outside of the indented block

{% objectives "Learning Objectives" %}

The old Starterkit style was formatted like this

{% endobjectives %}

可以使用不同风格的提示框：

Abstract

'abstract'通常用于学习目标

Info

'Info'通常用于需要突出显示的信息

Note

'Note'通常用于练习部分或需要读者尝试完成任务的地方

Warning

'Warning'用于警告内容

完整的提示框类型列表可在mkdocs官网上找到。

链接到其他页面

在 Starterkit 课程之间进行链接的语法略有不同：

新风格旧版 Starterkit 风格

[bookkeeping lesson](./bookkeeping.en.md)

The text will now read `bookkeeping lesson` as a clickable link to the bookkeeping lesson. Note that the path is relative.

[bookkeeping lesson](bookkeeping)

The old Starterkit style was formatted like this

$\LaTeX$

$\LaTeX$ 可以使用转义圆括号添加在行内，或使用转义方括号添加为块：

新风格旧版 Starterkit 风格

Here is some \\(\LaTeX\\) inline. A block of \\(\LaTeX\\) may be written as:

\\[
   a^2 + b^2 = c^2
\\]

Here is some $\LaTeX$ inline. A block of $\LaTeX$ may be written as:

$$
    a^2 + b^2 = c^2
$$

脚注

可以添加脚注，脚注会自动相互链接.¹

The syntax for this is consistent between the new and old styles, first add a carret in square brackets.[^1]

然后课程的其余部分可以正常继续。

[^1]:
    Finally at the bottom of the page, indented by four spaces (exactly),the footnote will be found. 
    It will link up automatically.

脚注将显示在页面底部。 ↩

贡献指南速查表

提示框（Admonitions）

链接到其他页面

\(\LaTeX\)

脚注