使用Git Wiki 管理文档时,文档编写的基本用法
自己初次接触GitLab,通过百度和自己查找资料,了解了一部分。在自己的工作中,主要用到GitLab的Wiki文档版本管理能力。我总结了一小部分文本编辑需要用到的东西。
一、文本的排版
为了让文本/文档的结构清晰明了,我们需要一下标题结构和文本格式。Wiki 主要的文本编辑语法用到的是Markdown。Markdown语法兼容HTML,可以直接在文档里用HTML撰写,只是有一些区块元素<div><table><pre><p>等标签,必须在前后加空行与其他内容分开。
1.标题
1.1 类Atx形式
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
注:#后有一空格
效果图:
1.2 类Setext形式
利用底线=和-,构建两级标题,例如:
一级标题
=====
二级标题
--------
效果图:
1.3 直接使用HTML
在Markdown语法中可以直接使用非区块的标签,所以HTML标题标签是可以在markdown中直接使用,例如:
<h1>一级标题</h1>
<h2>二级标题</h2>
<h3>三级标题</h3>
效果图:
2. 段落
创建段落时,需要在段前和断后插入一行空行。例如:
This is a beautiful girl and
she is learning the Markdown.May be she will know the
difference between
Markdown and HTML.When she know how to use it, she will love it.
效果图:
3.区块
使用>符号,在每行的最前面加上>.例如:
>This is a beautiful girl and she is learning the Markdown.
>
>May be she will know the difference between Markdown and HTML.
>
>
>When she know how to use it, she will love it.
效果图:
4.强调
使用*,_设置强调的文字。例如:
This is a beautiful girl and she is learning the *Markdown*.May be she will know the _difference_ between _Markdown_ and *HTML*.When she know how to use it, she will love it.
效果图:
5.列表(有序和无序)
5.1 无序列表
无序列表需要利用星号、加号、减号做列表标记,符号后加一空格。例如:
* first item
* second item
+ third item
+ forth item
- fifth item
- sixth item
效果图:
5.2 有序列表
有序列表只需使用数字接着一个英文句号
6.链接
格式:[link](地址),例如:This is a [行内链接](http://i.cnblogs.com)。
效果图:
7.分隔线
利用三个以上的*,-,_(星号,减号,底线)建立分隔线。例如:
******
这是一条分隔线
____
这也是一条分隔线
效果图:
8.反斜杠:markdown 中可以利用反斜杠来插入一些具有其他意义的符号,例如:具有强调的星号。
\*无强调\*
*有强调*
效果图:
使用Git Wiki 管理文档时,文档编写的基本用法的更多相关文章
- 电商管理后台 API 接口文档
1. 电商管理后台 API 接口文档 1.1. API V1 接口说明 接口基准地址:http://127.0.0.1:8888/api/private/v1/ 服务端已开启 CORS 跨域支持 AP ...
- javadoc 生成帮助文档时,注意以下几点
参考:http://www.w3school.com.cn/tags/tag_pre.asp javadoc 生成帮助文档时,注意以下几点: 1.函数功能描述的结尾一定要有句号,英文句号或中文句号均可 ...
- 打开word文档时提示“Microsoft Office Word已停止工作”
我的电脑(Win10)有Office 2003和2013两个版本,可能由于之前超长待机等原因导致word 2003的文件(.doc)不能正常打开,没次都会提示“Microsoft Office Wor ...
- notepad++新建文档时,会出现语法错误的红色下波浪线
notepad++新建文档时,会出现语法错误的红色下波浪线: 原因:新建文档时默认设置语言为PHP. 解决方法:修改默认语言为java或JavaScript,如下: 小结:打开文档时,也可能出现下波浪 ...
- 使用C#动态生成Word文档/Excel文档的程序测试通过后,部署到IIS服务器上,不能正常使用的问题解决方案
使用C#动态生成Word文档/Excel文档的程序功能调试.测试通过后,部署到服务器上,不能正常使用的问题解决方案: 原因: 可能asp.net程序或iis访问excel组件时权限不够(Ps:Syst ...
- MongoDB 大数据技术之mongodb中在嵌套子文档的文档上面建立索引
一.给collection objectid赋自定义的值 MongoDB Enterprise > db.testid.insert({_id:{imsi:"4567890123&qu ...
- 懒得写文档,swagger文档导出来不香吗
导航 前言 离线文档 1 保存为html 2 导出成pdf文档 3 导出成Word文档 参考 前言 早前笔者曾经写过一篇文章<研发团队,请管好你的API文档>.团队协作中,开发文档的重 ...
- 把 MWeb Lite 的文档库文档和数据搬到 MWeb 正式版中
MWeb Lite 版的文档库中的文档要搬到 MWeb 正式版中,如果 Lite 版的文档中没有图片或者只有少量图片,可以用导入导出为 Markdown 的方法. 否则的话请用以下方式(注意下面这个方 ...
- 关于HTML文档的文档模式
HTML文档的文档模式包括混杂模式和标准模式,这两种模式主要影响CSS内容的呈现,但在某些情况下也会影响到JavaScript的解释执行. 如果在文档开始处没有发现文档类型声明,则所有浏览器都会默认开 ...
随机推荐
- [洛谷P4341][BJWC2010]外星联络
题目大意:给你一个长度为$n(n\leqslant3\times10^3)$的字符串,要你求出其中出现次数大于$1$的子串,并按字典序输出次数. 题解:建$SAM$后求出每个点的$size$,最后按字 ...
- 【MVVM Dev】PART_Editor的使用
一.前言 在日常的界面开发中,我们大多使用MVVM模式进行开发.通常情况下,一个PropertyGridControl或者DataGrid的ItemsSource设置好, 然后每一列绑定好 ...
- 常州day5
Task 1 小 W 和小 M 一起玩拼图游戏啦~ 小 M 给小 M 一张 N 个点的图,有 M 条可选无向边,每条边有一个甜蜜值,小 W 要选 K条边,使得任意两点间最多有一条路径,并且选择的 K条 ...
- 【BZOJ2109/2535】【NOI2010】航空管制(贪心)
[BZOJ2109/2535][NOI2010]航空管制(贪心) 题面 BZOJ2109 BZOJ2535 题解 很好玩的一道题目 先看第一问,显然是要找一个合法的拓扑排序的序列. 直接拓扑排序,把队 ...
- php配置说明
1上传文件限制配置 post_max_size = 200M upload_max_file_size = 200M
- Yii2 数据库基本操作
//1.简单查询 $admin=Admin::model()->findAll($condition,$params); $admin=Admin::model()->findAll( ...
- jquery动态添加的元素绑定的事件不生效的问题
我们可以通过 $(document).on('click', '#xxx', callback) 这种形式解决. 原因,一般情况下,我们是通过 $('#xxx').click(callback) 这种 ...
- MySQL查询和修改auto_increment的方法
查询表名为tableName的auto_increment值: 复制代码 代码如下: SELECT AUTO_INCREMENT FROM information_schema.tables WHER ...
- selectors
一.Selectors模块 它具有根据平台选出最佳的IO多路机制,比如在win的系统上他默认的是select模式而在linux上它默认的epoll,建议使用selectors. 常用共分为三种:sel ...
- 全表 or 索引
这一篇文章证实了以前对MySQL优化程序的工作原理. MySQL就像一个人一样,总是聪明的去选择当前最快的方式去查询,而不是像Oracle数据那样死板地根据规格去查询. 查询的要求在于快.而对于数据库 ...