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

    效果图:

  • 相关阅读:
    BZOJ4889: [TJOI2017]不勤劳的图书管理员
    BZOJ3932: [CQOI2015]任务查询系统
    BZOJ1926: [Sdoi2010]粟粟的书架
    POJ 3281 Dining(网络流-拆点)
    POJ 1273 Drainage Ditches(网络流-最大流)
    POJ 1325 Machine schedine (二分图-最小点覆盖数=最大匹配边数)
    HDU 1281 棋盘游戏
    HDU2255 奔小康赚小钱钱(二分图-最大带权匹配)
    HDU 2444 The Accomodation of Students (二分图存在的判定以及最大匹配数)
    POJ 3660 cow contest (Folyed 求传递闭包)
  • 原文地址:https://www.cnblogs.com/xingzc/p/6390035.html
Copyright © 2011-2022 走看看