使用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 中可以利用反斜杠來插入一些具有其他意義的符號,例如:具有強調的星號。
                  
\*無強調\*
            
*有強調*

效果圖:


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM