自己初次接触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. CodeForces - 955B(用char会超时。。。)

    #include <bits/stdc++.h> #define mem(a, b) memset(a, b, sizeof(a)) using namespace std; , INF ...

  2. 使用StoryBoard执行动画

    在WPF动画编程中,最常用的动画处理方式是DoubleAnimation动画,但是随着你的开发经验越来越多,你会发现,有时候使用这个动画类会很麻烦,因为这个动画是封闭动画,也就是说在动画的时间间隔内, ...

  3. 【BZOJ1566】【NOI2009】管道取珠(动态规划)

    [BZOJ1566][NOI2009]管道取珠(动态规划) 题面 BZOJ 题解 蛤?只有两档部分分.一脸不爽.jpg 第一档?爆搜,这么显然,爆搜+状压最后统计一下就好了 #include<i ...

  4. 【BZOJ1497】【NOI2006】最大获利(网络流)

    [BZOJ1497][NOI2006]最大获利(网络流) 题面 BZOJ Description 新的技术正冲击着手机通讯市场,对于各大运营商来说,这既是机遇,更是挑战.THU集团旗下的CS& ...

  5. redis的自带VM(虚拟内存)

    Redis支持采用VM技术,以达到当数据超过设置的可使用的物理内存的时候能够正常运行.当数据超过物理内存的时候,把一部分数据写入磁盘中的一块空间来代替物理内存. vm-enabled no       ...

  6. springMVC和mybatis的原理

    mybatis是什么? mybatis是一个持久层框架,是apache下的开源项目,前身是itbatis,是一个不完全的ORM框架,mybatis提供输入和输出的映射,需要程序员自己写sql语句,my ...

  7. 对SLIP,PPP,PPPoE,EtherNet的理解。[zz]

    经常看到PPP,PPPoE这些名词,当时也查了不少的资料,但是一直不太理解这是什么东西,干什么用的,今天静下心来,多看了点资料,有了一些初步理解,记录下来,以后有了新的理解再修改.   首先,SLIP ...

  8. 对于redis框架的理解(三)

    上一篇讲完了initServer的大体流程,其中aeCreateEventLoop(),这个函数 没有详细说明,我们在这一篇里讲述Ae.h和Ae.c, 这里面的api阐述了如何创建 eventLoop ...

  9. python函数的输入参数

    http://note.youdao.com/noteshare?id=c2a0a39ee3cae09a62dcbc9f96d04b56

  10. .Net并行编程系列之一:并行基础

    现在普通PC平台上面多核处理器的普及,让我们领教了能够利用多核进行并行计算的软件的处理能力,同时继承更多地核心正是当前处理器发展的趋势. 但是作为一个.NET开发人员,是否有时候会发现你的程序占用了其 ...