使用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 中可以利用反斜杠来插入一些具有其他意义的符号,例如:具有强调的星号。
                  
\*无强调\*
            
*有强调*

效果图:

时间: 2024-12-31 03:10:44

使用Git Wiki 管理文档时,文档编写的基本用法的相关文章

sharepoint 2013 使用Office Web Apps 查看或编辑office文档时页面出现:“抱歉,出现了问题”错误

sharepoint 使用Office Web Apps 查看或编辑office文档时页面出现:"抱歉,出现了问题"错误 该问题是由于使用了系统账户登录站点而导致的. 更换其他账户登录问题解决. 其他错误还有下面的: 如果 Office Web Apps 在与 SharePoint 2013 结合使用时未正常工作,请查看以下症状并展开相应的标题以查找纠正步骤. 问题:当您选择 SharePoint 库中的"新文档"链接时,系统提示您上载某个文档而不是为您提供用于创建

3.30日第八次作业,第14章,采购管理,15章,信息文档和配置管理

3.30日第八次作业,第14章,采购管理,15章,信息文档和配置管理   第14章.采购管理1.采购管理包括哪些过程?(记)P382-383 答:1).编制采购计划.2).编制询价计划.3).询价.招投标.4).供方选择.5).合同管理.6).合同收尾. 2.编制采购计划过程的成果是什么?P386-387 答:1).采购管理计划.2).采购工作说明书. 3.判断:每个采购工作说明书都来自于项目范围基准.P387 答:是的. 4.结合P388页表14-1,工作说明书应该清楚地描述哪些内容?P388

Word 2010打开大文档时速度很慢的解决方法

这两天终于搞清楚了一个困扰了我很久的问题.我的Word 2010在打开很大的Word文档(如小组的硕士学位论文)时,经常发生速度慢甚至很长时间没有响应的问题.在师弟的提示下,终于找到一个折衷的解决方案: 其实是对中英文混合大文档拼写检查的问题,关闭拼写和语法检查就可以了,设置方法:点击"文件"--"选项"--"校对"--取消"在Word中更新拼写和语法时"下的所有对号.就可以顺利打开Word文档了. 另外,我们在英文的时候需要

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

参考:http://www.w3school.com.cn/tags/tag_pre.asp javadoc 生成帮助文档时,注意以下几点: 1.函数功能描述的结尾一定要有句号,英文句号或中文句号均可.不然会有方法摘要里会出现后边一大片内容. 2.换行用<p> 3.<pre> 元素可定义预格式化的文本.被包围在 pre 元素中的文本通常会保留空格和换行符.而文本也会呈现为等宽字体. public class JavadocDemo { /** * 这个函数的功能是返回你输入的字符串

解析XML文档时Node和Element的区别

文档对象模型DOM(Document Object Module)定义了用户操作文档对象的接口,它使得用户对HTML有了空前的访问能力,并使开发者能将HTML作为XML文档来处理. 使用C++的TinyXML解析XML文档时,会有两套方法,一套操作Node,一套操作Element. Node(节点)是DOM层次结构中的任何类型的对象的通用名称,Node有很多类型,如元素节点,属性节点,文本节点,注释节点等,通过NodeType区分,常见的有: 节点类型 NodeType 元素Element 1

合并文档时让第一页为奇数

目的:实现打印时自动将第一页排在奇数页,以防出现两份资料不独立的情况.</pre><pre name="code" class="vb">因为是双面打印,故必须让文档的第一页位于奇数页,可以获取页码,插入空白页,可以插入奇数页分页符 Sub 合并文档时让第一页为奇数() 'ThisDocument.BuiltInDocumentProperties(wdPropertyPages) Rem Selection.Information(wdNu

IIS7.5网站添加默认文档时提示“由于权限不足而无法写入配置文件”。

在对网站添加默认文档时提示“由于权限不足而无法写入配置文件”. 其实这不是权限不足造成的,而是网站的配置文件属性是“只读”造成的. 右击网站配置文件--属性--属性项里去掉只读--确定.

当xml中存在命名空间,dom4j解析以及写入xml文档时的乱码问题

最近公司项目开发中需要通过前台用户界面进行客户业务系统的部署(提供界面化操作,减少运维工作的难度),通过修改web.xml进行设置各个项目不同的信息配置. 开发过程中遇到2种问题,同时将解决方案备注上,以方便日后查看. 问题一:当xml中存在命名空间,三种处理办法(dom4j) 问题二:文件保存之后总是提示中文乱码问题 针对上面2个问题的解决方案进行汇总,解决方法主要还是来自于其他网络同行的博客. 第一个 问题主要参照 博客http://blog.sina.com.cn/s/blog_5cef6

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

notepad++新建文档时,会出现语法错误的红色下波浪线: 原因:新建文档时默认设置语言为PHP. 解决方法:修改默认语言为java或JavaScript,如下: 小结:打开文档时,也可能出现下波浪线,可在此处修改语言: 原文地址:https://www.cnblogs.com/mediocreWorld/p/11014651.html