日常学习-wiki文档的编写

对于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


  • 0
    点赞
  • 13
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值