down mark 打钩_markdown文档撰写技巧

github 上 readme.md文件书写规范：(支持markdown语法)

1、编辑README文件

大标题(一级标题)：在文本下面加等于号，那么上方的文字就变成了大标题，等于号的个数无限制，但一定要大于0

大标题

====

中标题(二级标题)：在文本下面加下划线，那么上方的文本就变成了中标题，下划线个数无限制，中标题比大标题低一级

中标题

-------

1~6级标题：文本大小依次减小，以#号开头，多少个#号就是多少级标题，#号和标题名称要并排写

#一级标题

##二级标题

###三级标题

####四级标题

#####五级标题

######六级标题

插入圆点符号：编辑的时候使用的是星号 *，星号后面要有一个空格，否则为普通星号

* 列表一

* 列表二

* 列表三

二级圆点、三级圆点：多加一个Tab，即第二行一个Tab，第三行两个Tab

* 列表一

* 列表二

*列表三

缩进：

>缩进一

>>缩进二

>>>缩进三

>>>>缩进四

>>>>>缩进五

插入链接

[百度](http://baidu.com)

插入网络图片：![](网络图片链接地址)，即叹号!+方括号[]+括号()，如果不加叹号!就会变成普通文本，方括号里可以加入一些标识性的信息

![baidu](http://www.baidu.com/img/bdlogo.gif "百度logo")

插入GITHub仓库里的图片：![](图片链接地址)，即叹号!+方括号[]+括号()，URL写法：http://github.com/自己的用户名/项目名/raw/分支名/存放图片的文件夹/文件夹里的图片名字

给图片加上超链接：即点击一个图片进入指定网页，方括号里写自己起的标识名称，上下两行标识要一致。

[![baidu]](http://baidu.com)

[baidu]:http://www.baidu.com/img/bdlogo.gif "百度Logo"

插入代码片段：在代码上下行用```标记，注意`符号是tab键上面那个，要实现语法高亮，则在```后面加上编程语言的名称

复制代码

```Java

public static void main(String[] args){}

```

```javascript

document.getElementById("ts").innerHTML="Hello"

```

复制代码

换行：使用标签

单行文本：前面使用两个Tab

多行文本:每行行首加两个Tab

部分文字高亮：使用``包围，这个符号不是单引号，而是Tab上方，数字1左边那个按键的符号

文字超链接格式：[要显示的文字](链接的地址"鼠标悬停显示")，在URL之后用双引号括起来一个字符串，即鼠标悬停显示的文本，可不写

备注：如何添加README文件？

#在创建项目的时候在README那处打钩

down mark 打钩_markdown文档撰写技巧相关推荐

部署文档撰写经验分享
2011年,公司调我和几个同事去广西,与现场的同事一起撰写部署文档.去之前还感觉领导有点小题大做,写个部署文档至于么?我在公司半天就能写出一版了,还叫这么多人跑到广西写这个,真是崽卖爷田不心疼,公司费 ...
需求文档撰写——心得
前言写文档遇到问题: 1.没想清楚,对产品的需求功能或业务逻辑等不够清晰. 2.想清楚没写出来,思路转化为文字描述. 3.文档撰写思考不够全面和独立性. 解决方案: 1.明确需求分类,首先确定有多少 ...
python docx 合并文档图片_MBT文档模型化生成工具——30倍效率文档撰写工程化方法...
MBT(A model based document builder)文档模型化生成工具用户手册--30倍效率文档撰写工程化方法 1 简介在软件工程领域,工程文档通常主要包括实施方案.需求分析.软件 ...
MRD文档撰写方法与技巧
继上一篇<BRD文档撰写方法与技巧>,今天又给大家分享一篇原创的<MRD文档撰写方法与技巧>,希望大家能互相学习,互相分享,一起折腾. 何谓MRD? 同样在了解MRD涵盖那些方 ...
杂谈PPT文档撰写(原创)
Normal 0 7.8 磅 0 2 false false false EN-US ZH-CN X-NONE杂谈PPT文档撰写说到PPT,其实更是一门学问:运用起来说简单也简单,说复杂也是很复杂. ...
rmd中无法打开链结r_R语言数据实战 | 代码规范与文档撰写
点击上方"蓝字"带你去看小星星 R语言虽然有着强大的统计分析和绘图功能,但说到底它是一门编程语言.既然如此,那么R语言就有自己的代码规范,这些规范旨在让R学习者养成良好的代码写作习 ...
一次性解决微信支付-JSAPI支付问题（想把微信支付JSAPI文档撰写者按在地上摩擦）
最近一个项目需要接入微信支付,所以在现有的项目中接入这个功能,但是最终发现,微信支付是个大坑,至少我认为微信支付文档的撰写者应该是小学水平,又或者是幼儿园水平,写文档的能力简直无语,很多关键性的细节居 ...
Word 2003 长篇文档排版技巧
简介市场部经常要出各种分析报告,一写就是洋洋洒洒几十页.文字功底深厚的小王写东西自然不在话下,然而每每困扰他的却是排版的问题,每次都要花大量的时间修改格式.制作目录和页眉页脚.最头疼的是上司看完报告 ...
文档过期打不开怎么办_4 个超实用金山文档小技巧，很强大也很简单，赶紧收藏！...
01 设置文档权限,保护文档安全金山文档除了可以通过链接分享给QQ.微信等好友或群组邀请对方协作编辑外,同时可以为文档设置不同权限. 以金山文档网页版举例(手机金山文档小程序同理) 打开文档后,点击 ...

down mark 打钩_markdown文档撰写技巧

down mark 打钩_markdown文档撰写技巧相关推荐

最新文章

热门文章