对于wiki
文档的编写,这里将常用的都举例。
对于wiki
语法我们一般选择 markdown
,因为其功能最多,也是最常用的。
这里都以markdown
进行说明。编写的工具推荐使用 typora
文本内容
标题
这里当标题为title
# title
一级标题
## title
二级级标题
### title
三级级标题
依次类推。 文章应该以标题来划分,更加清晰。
当然你也可以使用
这3
个按钮来实现1-3
级的标题
链接
想文字链接网址,可以这样写:
[百度的啦](https://www.baidu.com)
就会表现为 百度的啦
图片
图片需要先有一个地址,你可以自己上传
或者从网上找到其URL地址
![文字说明](图片地址)
文字说明不会显示,所以我们一般会这样写
![](图片地址)
文字高亮
一般使用
`文字内容`
即表示为:
文字内容
比较常用,通常一句话里面有需要标记
的文字就使用下,更方便阅读
代码
使用```来包含代码
结果就如下:
code = 1 + 2
使用```c就表示代码需要以C语言的格式显示
文字格式
*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___
斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本
列表
有序列表
1. 内容1
2. 内容2
无序列表
* 内容
- 内容
+ 内容
分割线
***
---
___
表示如下:
表格
表格格式比较麻烦,可以去这个 网址 编辑之后复制就最方便了
注意要选择markdown
语法的拉!
下拉列表
<details>
<summary>这里是下拉</summary>
这里是下拉内显示的内容,记得先空一行
</details>
表现为
引用
一般用于某些单独说明
> 一级引用
>> 二级引用
>>> 三级引用
一级引用
二级引用
三级引用
Side Bar
就是右侧的一个目录,像这样子的:
其语法为: 标题 + URL + 无序列表
## SDK介绍
* [RtSDK介绍](https://github.com/net263/RtSDK/wiki/RtSDK%E4%BB%8B%E7%BB%8D)
## 如何开始
* [进入直播](https://github.com/net263/RtSDK/wiki/%E8%BF%9B%E5%85%A5%E7%9B%B4%E6%92%AD)
* [相关回调](https://github.com/net263/RtSDK/wiki/%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
* [流程图](https://github.com/net263/RtSDK/wiki/%E6%B5%81%E7%A8%8B%E5%9B%BE)
## 模块
* [视频 Video](https://github.com/net263/RtSDK/wiki/%E8%A7%86%E9%A2%91-Video)
* [多路视频 Multi-Video](https://github.com/net263/RtSDK/wiki/%E5%A4%9A%E8%B7%AF%E8%A7%86%E9%A2%91-Multi-Video)
* [插播播放 LOD](https://github.com/net263/RtSDK/wiki/%E6%8F%92%E6%92%AD%E6%92%AD%E6%94%BE-LOD)
footer
footer
可以这样写
[Installation](https://github.com/onevcat/Kingfisher/wiki/Installation-Guide) - [Cheat Sheet](https://github.com/onevcat/Kingfisher/wiki/Cheat-Sheet) - [FAQ](https://github.com/onevcat/Kingfisher/wiki/FAQ) - [API Reference](http://onevcat.github.io/Kingfisher/)
Installation - Cheat Sheet - FAQ - API Reference
同样是markdown
的语法
参考文章
https://help.github.com/en/github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki
https://blog.csdn.net/sun8112133/article/details/79871702
https://blog.csdn.net/sun8112133/article/details/79891479