自己初次接触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 管理文档时,文档编写的基本用法的更多相关文章

  1. 电商管理后台 API 接口文档

    1. 电商管理后台 API 接口文档 1.1. API V1 接口说明 接口基准地址:http://127.0.0.1:8888/api/private/v1/ 服务端已开启 CORS 跨域支持 AP ...

  2. javadoc 生成帮助文档时,注意以下几点

    参考:http://www.w3school.com.cn/tags/tag_pre.asp javadoc 生成帮助文档时,注意以下几点: 1.函数功能描述的结尾一定要有句号,英文句号或中文句号均可 ...

  3. 打开word文档时提示“Microsoft Office Word已停止工作”

    我的电脑(Win10)有Office 2003和2013两个版本,可能由于之前超长待机等原因导致word 2003的文件(.doc)不能正常打开,没次都会提示“Microsoft Office Wor ...

  4. notepad++新建文档时,会出现语法错误的红色下波浪线

    notepad++新建文档时,会出现语法错误的红色下波浪线: 原因:新建文档时默认设置语言为PHP. 解决方法:修改默认语言为java或JavaScript,如下: 小结:打开文档时,也可能出现下波浪 ...

  5. 使用C#动态生成Word文档/Excel文档的程序测试通过后,部署到IIS服务器上,不能正常使用的问题解决方案

    使用C#动态生成Word文档/Excel文档的程序功能调试.测试通过后,部署到服务器上,不能正常使用的问题解决方案: 原因: 可能asp.net程序或iis访问excel组件时权限不够(Ps:Syst ...

  6. MongoDB 大数据技术之mongodb中在嵌套子文档的文档上面建立索引

    一.给collection objectid赋自定义的值 MongoDB Enterprise > db.testid.insert({_id:{imsi:"4567890123&qu ...

  7. 懒得写文档,swagger文档导出来不香吗

    导航 前言 离线文档 1 保存为html 2 导出成pdf文档 3 导出成Word文档 参考 前言   早前笔者曾经写过一篇文章<研发团队,请管好你的API文档>.团队协作中,开发文档的重 ...

  8. 把 MWeb Lite 的文档库文档和数据搬到 MWeb 正式版中

    MWeb Lite 版的文档库中的文档要搬到 MWeb 正式版中,如果 Lite 版的文档中没有图片或者只有少量图片,可以用导入导出为 Markdown 的方法. 否则的话请用以下方式(注意下面这个方 ...

  9. 关于HTML文档的文档模式

    HTML文档的文档模式包括混杂模式和标准模式,这两种模式主要影响CSS内容的呈现,但在某些情况下也会影响到JavaScript的解释执行. 如果在文档开始处没有发现文档类型声明,则所有浏览器都会默认开 ...

随机推荐

  1. 解数独(Python)

    0.目录 1.介绍 2.一些通用函数 3.全局变量(宏变量) 4.数独预处理(约束传播) 5.解数独(深度优先搜索+最小代价优先) 6.主函数 7.总代码 1.介绍 数独是一个非常有趣味性的智力游戏, ...

  2. js复选框插件

    <div class="selectList selectQgClass" id="selectQgClass"> <div class=&q ...

  3. HDU.1689 Just a Hook (线段树 区间替换 区间总和)

    HDU.1689 Just a Hook (线段树 区间替换 区间总和) 题意分析 一开始叶子节点均为1,操作为将[L,R]区间全部替换成C,求总区间[1,N]和 线段树维护区间和 . 建树的时候初始 ...

  4. 代码收藏系列--javascript--日期函数

    /** * 获取当前时间的简短函数 * @returns {String} * @@example getTimeStamp() 结果是:2017-07-12 09:21:30 */ function ...

  5. [JSOI2008]Blue Mary的战役地图——全网唯一一篇dp题解

    全网唯一一篇dp题解 网上貌似全部都是哈希+二分(反正我是大概baidu了翻了翻)(还有人暴力AC了的..) 哈希还是相对于dp还是比较麻烦的. 而且正确性还有可能被卡(当然这个题不会) 而且还容易写 ...

  6. 使用Hexo搭建GitHub博客(2018年Mac版)

    关于本文 本文仅记录自己学习搭建Hexo博客之时,搭建过程中掉坑的历程总结,对零基础起步的观众朋友可能缺乏某些基础技术的指导,请优先食用下述两篇优质教程: [2018更新]小白独立搭建博客-Githu ...

  7. Oracle10g数据泵impdp参数详解--摘自网络

    Oracle10g数据泵impdp参数详解 2011-6-30 12:29:05 导入命令Impdp •      ATTACH 连接到现有作业, 例如 ATTACH [=作业名]. •      C ...

  8. 9.Android UiAutomator正则表达式的使用

    一.正则表达式元字符: 1.一些常用元字符: 元字符 描述 . 表示任意一个字符 \s 空格字符(空格键.tab.换行.换页.回车) \S 非空字符串([^\s]) \d 一个数字(相当于[0-9]中 ...

  9. Vue.js随笔三(npm init webpack my-project指令安装失败解决方案)

    如果没有安装淘宝给的镜像就先安装一下,指令如下,对!就是如此简单: npm install -g cnpm -registry=https://registry.npm.taobao.org 首先输入 ...

  10. mac activemq

    安装 brew install maven 运行 To have launchd start activemq now and restart at login: brew services star ...