设为首页 收藏本站
查看: 1309|回复: 0

[经验分享] 使用Git Wiki 管理文档时,文档编写的基本用法

[复制链接]

尚未签到

发表于 2018-1-12 16:31:33 | 显示全部楼层 |阅读模式
  自己初次接触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.
  效果图:

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

运维网声明 1、欢迎大家加入本站运维交流群:群②:261659950 群⑤:202807635 群⑦870801961 群⑧679858003
2、本站所有主题由该帖子作者发表,该帖子作者与运维网享有帖子相关版权
3、所有作品的著作权均归原作者享有,请您和我们一样尊重他人的著作权等合法权益。如果您对作品感到满意,请购买正版
4、禁止制作、复制、发布和传播具有反动、淫秽、色情、暴力、凶杀等内容的信息,一经发现立即删除。若您因此触犯法律,一切后果自负,我们对此不承担任何责任
5、所有资源均系网友上传或者通过网络收集,我们仅提供一个展示、介绍、观摩学习的平台,我们不对其内容的准确性、可靠性、正当性、安全性、合法性等负责,亦不承担任何法律责任
6、所有作品仅供您个人学习、研究或欣赏,不得用于商业或者其他用途,否则,一切后果均由您自己承担,我们对此不承担任何法律责任
7、如涉及侵犯版权等问题,请您及时通知我们,我们将立即采取措施予以解决
8、联系人Email:admin@iyunv.com 网址:www.yunweiku.com

所有资源均系网友上传或者通过网络收集,我们仅提供一个展示、介绍、观摩学习的平台,我们不对其承担任何法律责任,如涉及侵犯版权等问题,请您及时通知我们,我们将立即处理,联系人Email:kefu@iyunv.com,QQ:1061981298 本贴地址:https://www.yunweiku.com/thread-434340-1-1.html 上篇帖子: git 使用那些事儿 下篇帖子: Sonar页面Author页面展示
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

扫码加入运维网微信交流群X

扫码加入运维网微信交流群

扫描二维码加入运维网微信交流群,最新一手资源尽在官方微信交流群!快快加入我们吧...

扫描微信二维码查看详情

客服E-mail:kefu@iyunv.com 客服QQ:1061981298


QQ群⑦:运维网交流群⑦ QQ群⑧:运维网交流群⑧ k8s群:运维网kubernetes交流群


提醒:禁止发布任何违反国家法律、法规的言论与图片等内容;本站内容均来自个人观点与网络等信息,非本站认同之观点.


本站大部分资源是网友从网上搜集分享而来,其版权均归原作者及其网站所有,我们尊重他人的合法权益,如有内容侵犯您的合法权益,请及时与我们联系进行核实删除!



合作伙伴: 青云cloud

快速回复 返回顶部 返回列表