全球最大的wiki,应该就是维基百科吧,其实百度百科,csdn写博客等等也是wiki,不久前自己接触了Github wiki的编写,因此做个记录吧
-
模式一般选择Markdown,因为这个模式的功能是最多的。
-
下图从左往右,分别编号为1到13
1 h1:Header 1,即一级标题,在文本中用 “# ”(#后面有一个空格)表示
2 h2:Header 2,即二级标题,在文本中用 “## ”(#后面有一个空格)表示
3 h3:Header 3,即三级标题,在文本中用 “### ”(#后面有一个空格)表示
4 Link:链接,例如把Github官网的链接可以这样写:
[Github](https://github.com)
5 Image:因特网上的图片链接
![图片代替文字](图片地址) //原图显示
![图片代替文字](图片地址=LenthxWidth) //设置高宽
6 Bold:字体粗体
**要加粗的文字**
7 Italic:斜体
_要斜体的文字_
8 Code:代码
`代码写在这里`
9 Unordered List:无序列表,在行开头使用,在文本中用“* ”(*后面有一个空格)表示
10 Ordered List:有序列表,在行开头使用,在文本中用“1. ”(.后面有一个空格)表示,显示会默认将1自动自增,但是还是建议自己写
11 Blockquote:块引用,在行开头使用,在文本中用“> ”(>后面有一个空格)表示
12 Horizontal Rule:水平分割线,一行只有“***”(3个*)或“---”(3个-)在开头
13 Help:帮助
- 换行
换行可以在想换行的末尾添加斜杠 / 或者敲2个空格
这里是列示要换行的行末尾\
这里是列示要换行的行末尾 (2个空格)
最后一行不需要添加
- 代码块:
当一行的代码很长,不希望wiki里面把这一行代码分好几行显示的话,只显示一行,有个左右拉的scrollbar。
使用方法是空一 行,然后第二行行首4个空格。其实可以用这种方法完全代替8 Code的功能。
这是适用于代码不多的情况。
第二种方法是当代码很多行的时候,可以使用 两个 ``` ,这是最方便的:
```
这里写代码
```
- 表格
表格也是可以显示的,最方便的方法是到这个网址复制粘贴:表格剪贴板
http://www.tablesgenerator.com/
在天朝学技术不容易,貌似要翻墙这个网址,直接把表格全选复制,然后在这个网址选好相应的行列粘贴即可
那么在wiki里面是怎么显示的呢,举个例子:
| 学号 | 名字 | 年龄 | 性别 |
|--------|--------|--------|-------|
| 01 | 牛牛 | 3 | / |
或者
| 学号 | 名字 | 年龄 | 性别 |
|:--------:|:--------:|:--------:|:-------:|
| 01 | 牛牛 | 3 | / |
记得间距对齐就行,显示的时候会自动生成一个表格
- 下拉列表
<details>
<summary>这里是下拉</summary>
这里是下拉内显示的内容,记得先空一行
</details>