Skip to content

Commit 168ce26

Browse files
committed
修正markdown 渲染的说明
1 parent be1d59c commit 168ce26

File tree

6 files changed

+35
-9
lines changed

6 files changed

+35
-9
lines changed
-15.7 KB
Loading
68.2 KB
Loading
60.6 KB
Loading
72.3 KB
Loading
56 KB
Loading

docs/rules/academic/handbook/markdown.md

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -134,27 +134,53 @@ __双下划线加粗__
134134

135135
### 大段代码
136136

137-
Markdown 建立代码块的方法:将 \`\`\` 置于这段代码的首行和末行,独立成一行。第一行的 \`\`\` 后面可以加上语言名称,例如 cpp、java、c、pascal 等(不要写成 c++)。
137+
Markdown 建立代码块的方法:将 \`\`\` 置于这段代码的首行和末行,独立成一行。第一行的 \`\`\` 后面可以加上语言名称,例如 cpp、java、c、pascal 等(不要写成 c++)。**请注意,对于未指定语言的程序代码会被 fallback 到 C++,其他无法识别的语言名称(如 plain)会作为普通文本渲染**
138138

139139
**例如:**
140140

141-
![C++代码示例](../_image/CppCode.png)
141+
![](./_image/code-unspecified-language.png)
142142

143-
```cpp
144-
#include<iostream>
143+
**显示的效果如下:**
144+
145+
![未指定语言的代码](./_image/unspecified-language.png)
146+
147+
148+
#### 显示行号【新特性】
149+
150+
如果要显示代码行号,在代码块的第一行加上 `line-numbers` 参数即可。
151+
152+
如下代码:
153+
```markdown
154+
```cpp line-numbers
145155
```
146156

147-
### 指定范围高亮【新特性】
157+
**显示的效果如下:**
158+
159+
![代码行号示例](./_image/code-linenumbers.png)
160+
161+
#### 指定范围高亮【新特性】
162+
163+
在代码块中首行使用 `lines=<start>-<end>` 参数来指定高亮范围。
164+
165+
如下代码:
166+
```markdown
167+
```cpp lines=6-9
168+
```
169+
170+
**显示的效果如下:**
171+
172+
![指定范围高亮示例](./_image/code-highlight.png)
148173

149-
在代码块中首行使用 `lines=<start>-<end>` 参数来指定高亮范围。例如:
174+
##### 行号显示与指定范围高亮的结合使用示例
150175

176+
如下代码:
151177
```markdown
152-
```cpp lines=5-6
178+
```cpp line-numbers lines=5-6
153179
```
154180

155-
![代码高亮示例](./_image/code-highlight.png "5~6 行高亮")
181+
![行号显示与指定范围高亮结合示例](./_image/code-linenumbers-highlight.png "5~6 行高亮")
156182

157-
这样代码块的第 5~6 行会被高亮显示。
183+
这样代码块就会显示行号,并且第 5~6 行会被高亮显示。
158184

159185
### 小段代码
160186

0 commit comments

Comments
 (0)