Team:Fudan/WikiInstruction

Release Date: 2021.08.03

Version: 1.1

本页内容：

  1. 一些说明
  2. Markdown 基本语法规则
  3. 当前 wiki 使用主题 Shoka 额外增加的语法规则

# 一些说明

# 关于 Markdown 语言

  1. Markdown 不是编程语言(因为其不涉及逻辑处理)，而是描述性语言，其完成的工作本质上就是图文排版
  2. 我们 wiki 的模板已经可以做到将 Markdown 语言直接转换为网页了！因此大家只需要用 Markdown 就可以了，不用再去学 HTML+CSS+js+... 了
  3. 石墨文档也支持部分 Markdown 语法(小声)

# 关于 Typora 编辑器

  1. Typora 是一款能够即时显示效果的编辑器，适用于 Markdown 基本语法的所有内容；但我们的 wiki 使用的 Shoka 主题新增了一些特殊的语法，Typora 就不能显示了
  2. 软件下载地址：官网链接

# 其他

Shoka 主题提供的字体修饰有很多，例如波浪线、着重点、荧光高亮、彩虹等等，但由于目前美工组还在设计配色方案，因此不展开细说具体有哪些修饰方法。所有需要强调的内容请先统一使用荧光高亮标出，待配色方案确定后会协助大家修改。

  1. 所有的语法规则，都会按照 基本格式 - 实例代码 - 实例效果 的形式呈现
  2. 推荐一边看一边在 Typora 编辑器上动手操作
  3. 此处仅列出了 Markdown 中较常用的一些功能，更多功能待通过鲁棒性验证后将在本网页更新(请关注 “本页内容” 处的更新日期与版本号)，建议收藏以方便查看
  4. 如有任何意见、建议或遇到困难，请找 GhoST👻

# Markdown 基本语法

# 标题

# 一级标题

格式

# 标题内容

实例

# Markdown基本语法

效果

见该部分大标题 Markdown 基本语法

# 二级标题

格式

## 标题内容

实例

## 字体

效果

见下部分小标题 字体

  1. 若干#号之间无需空格，#号与标题内容之间有一个空格
  2. 网页左侧的页面导航栏是根据一级标题、二级标题自动生成的：一级标题前面会加上序号 1. 2. 3.，二级标题前面会加上序号 1.1. 1.2. 1.3.，因此标题内容不要带序号

# 字体

格式

*倾斜文字*
**加粗文字**
***倾斜加粗文字***
~~删除文字~~

实例

*这是倾斜的文字*
**这是加粗的文字**
***这是倾斜加粗的文字***
~~这是有删除线的文字~~

效果

这是倾斜的文字
这是加粗的文字
这是倾斜加粗的文字
这是有删除线的文字

* 号和～号与文字之间没有空格

Shift`~ 号的打法：Shift + `(上方数字键 1 左边的键)

# 分割线

格式

---

效果

除了可以用

---

还可以用

***

并且，- 和 * 的数量不一定是 3 个，只要大于等于 3 个都可以，效果均相同

# 图片

格式

![图片Alt](图片地址)

图片 Alt 指的是图片关键词，是当图片因为某些原因无法显示的时候出现的替代文字，同时也是百度等搜索引擎搜索图片时的关键词。在我们的 wiki 中可以省略不写。

实例

![](https://static.igem.org/mediawiki/2021/b/b6/T--Fudan--ExamplePage--PageHeadBackground.jpg)

效果

这里用到的小括号 () 和中括号 [] 需要在 英文状态 下输入，否则无效

# 超链接

格式

[显示文字](链接地址)

实例

[Shoka模板测试页面](https://2021.igem.org/Team:Fudan/ExamplePage/NewContent)

效果

Shoka 模板测试页面

这里用到的小括号 () 和中括号 [] 需要在 英文状态 下输入，否则无效

# 列表

# 无序列表

格式

- 列表内容

实例

- Team
- Project
- Parts
- Safety
- Human Practice
- Awards
- Poster

效果

  • Team
  • Project
  • Parts
  • Safety
  • Human Practice
  • Awards
  • Poster

- 号与内容之间需要有一个空格

  1. 除了可以使用 - 号，还可以使用 + 号、 * 号，效果相同。但符号与内容之间都需要有一个空格
  2. 在 Typora 编辑器中，一旦有了第一个列表内容，按 Enter 就会自动生成下一个列表项目，再按 Enter 则会停止自动生成列表项目

# 有序列表

格式

1. 列表内容

实例

1. Research
2. Imagine
3. Design
4. Build
5. Test
6. Learn
7. Improve

效果

  1. Research
  2. Imagine
  3. Design
  4. Build
  5. Test
  6. Learn
  7. Improve

序号和小数点之间没有空格，小数点和内容之间有空格

# 列表的嵌套

实例

1. Research
   - Teacher
   - Website
   - ...
2. Imagine
   - Outline
   - ...

效果

  1. Research
    • Teacher
    • Website
    • ...
  2. Imagine
    • Outline
    • ...

无序、有序列表自身、相互都可以嵌套。需要做的仅是在次一级的序号 / 符号前面加上三个空格

# 表格

格式

|列1|列2|列3|...|
|对齐说明|对齐说明|对齐说明|...|
|内容|
  1. | 号即 C / Python 语言中表示 “或运算” 的符号
  2. Typora 编辑器功能比较完善，你只需输入第一行(即带有分隔符的表头)就会自动生成表格，然后可以鼠标操作
  3. 对齐说明参考如下：
    • 文字默认左对齐，即输入 -
    • 文字居中：输入:-:
    • 文字右对齐：输入 -:
    • 输入的 - 号数量不作限制，有一个就行，为了对齐可以多加几个
    • 冒号需要在 英文状态 下输入

实例

|列1|列2|列3|
|--|:--:|-:|
|1-1|1-2|1-3|
|2-1|2-2|2-3|

效果

列 1 列 2 列 3
1-1 1-2 1-3
2-1 2-2 2-3

# Shoka 新增的语法规则

# 上下标

# 上标

格式

^上标文字^

实例

Jan. 1^st^

效果

Jan. 1st

# 下标

格式

~下标文字~

实例

H~2~O

效果

H2O

^ 号 和～号与上下标内容之间没有空格

# 突出显示

# 荧光高亮

格式

==高亮文字==

实例

==划重点==

效果

划重点

两个等号与高亮内容之间没有空格