编写文档,有很多格式选择,也有不同平台选择。下面就自己接触到的MarkDown编写文档的各种技巧做简单梳理,供自己参阅,也希望帮到网友。


【1】添加空格

 

这种写法比较老土,但是,很实用!注意都是英文状态下的字符,想要多个空格就多复制几次,怎么样的排版都能排上!



键入全角输入状态下"空格",直接敲击键入即可!

这种方法很快捷,但也有弊端,不容易在编辑栏中查询修改,建议用一种方式输入空格,尽量避免多种方式混用!

【2】文字标重

指的是将文字内容加粗、加背景颜色等视觉效果,以此让文本整体渲染得更好看,也提醒读者一些重要信息。

加粗 可用** **来标记,如:

**这是一行被加粗的句子**

斜字 可用* *来标记,如:

*这是一行倾斜的句子*

粗斜体 可用*** ***来标记,如:

***这是一行粗斜体文字***

加底色 可用== ==来标记,如:

==这里需要被添加底色==

【3】代码(块)

单行代码(有时也可作为重标文字来使用):

你好 a=1 *p=*p1+*p2

编写方法[ 用`来包裹文字内容]:

`你好` `a=1` `*p=*p1+*p2`

多行代码 [代码块]:

int a = 1;
int b = -100; void main()
{
int c = a + b;
println(c);
}

使用```来包裹文本,如:

```

int a = 1;

int b = -100;

void main()

{

int c = a + b;

println(c);

}

 ```

还能定义特定语种,如:

 ```c++

//这里是c++代码

```

即在首个``` 后面加上语种。

【4】换行 空行

空行上键入  ,如:

我是一行普通的文本
 
 
 
我也是一行普通的文本
 
我还是一行普通的文本

得到结果:

我是一行普通的文本

 

 

 

我也是一行普通的文本



我还是一行普通的文本

键入:<br>

我是一行普通的文本
<br>
我也是一行普通的文本
<br>
我还是一行普通的文本

得到结果:

我是一行普通的文本



我也是一行普通的文本



我还是一行普通的文本

【5】引文

键入:>,如:

> 哈哈,我是引文

得:

哈哈,我是引文

还能分级显示,如:

> 我是一级文本
>> 我是二级文本
>>> 我是三级文本 >> 我是二级文本
> 我是一级文本

得到:

我是一级文本

我是二级文本

我是三级文本

我是二级文本

我是一级文本

还能在引文中嵌入代码块:

> 我是一行文本
>>  ```
>>  int a = 0;
>>  ```

得:

我是一行文本

   int a = 0;  

【PS】注意`>`后面是可以跟上多行文本的,直到遇到回车换行。如下情况:

我是一行很长的文本。巴拉巴拉巴拉巴拉巴拉巴拉

发生的方式方式放松放松故事故事发发怪怪的发说法萨芬的

分身乏术分身乏术发顺丰撒发顺丰撒方式方法撒飞洒发

分身乏术发顺丰撒发生的方式。



发送到方式放松放松发送方师傅。

写法如下:

> 我是一行很长的文本。巴拉巴拉巴拉巴拉巴拉巴拉
发生的方式方式放松放松故事故事发发怪怪的发说法萨芬的
分身乏术分身乏术发顺丰撒发顺丰撒方式方法撒飞洒发
分身乏术发顺丰撒发生的方式。
<br>
发送到方式放松放松发送方师傅。

【6】分割线

---
***
___

即在空行上键入三个及三个以上的\*_即可!

【7】删除线

被删除的文本

~~被删除的文本~~

在文本前后用~~包裹。

【8】下划线

带下划线的文本

<u>带下划线的内容</u>

这是借用了Html5中的标记符号。

【9】列表

一、无序列表

键入* + - 都可[注意后面加个空格],如:

* 文本1
* 文本2
- 文本2
+ 文本3

得到:

  • 文本1
  • 文本2
  • 文本2
  • 文本3

二、有序列表

键入1. 2. 10. 等,如:

1. 文本1
2. 文本2
3. 文本3
10. 文本4
1. 文本5

得到:

  1. 文本1
  2. 文本2
  3. 文本3
  4. 文本4
  5. 文本5

【PS】这里我故意改写成10.和1.,能够发现markdown系统自动识别列表序号,无关用户写的具体数字。

当然还可以加入层级,如:

1. 文本1
2. 文本2
1. 文本4
2. 文本5
2. 文本5
3. 文本3

得到:

  1. 文本1
  2. 文本2
    1. 文本4
    2. 文本5
    3. 文本6
  3. 文本3

【PS】有的系统会自动修改标注,加入不同层级的显示。

需要定义下级的文本,在开头添加一个缩进符tab或者3个以上的空格(太多空格不一定被识别)

结语

还有一些高级应用下篇继续。值得说的是,不同的平台,系统配置都有些许差距,得到的效果可能不太一样,属正常现象。

Markdown 编写技巧汇总(一)的更多相关文章

  1. 移动平台3G手机网站前端开发布局技巧汇总

    移动平台3G手机网站前端开发布局技巧汇总 作者:前端开发-武方博   发布:2011-05-10 09:11   分类:移动开发   阅读:120,618 views   7条评论     您或许正在 ...

  2. 移动平台WEB前端开发技巧汇总(转)

    最近我很关注移动前端的知识,但做为一个UI设计师和web前端工作人员没有这个工作环境接触,做为门外汉,网上系统的知识也了了,一直有种雾里看花的感觉,见到本文,我自己是奉为经典.所以我分享之后又专门打笔 ...

  3. 简历编写技巧-java开发工程师简历实战

    看到一遍简历编写的文章 想到也快找工作了 早晚能够用上 现在摘录如下 640?wx_fmt=jpeg 工欲善其事,必先利其器,这是自古以来的道理.所以如果想找到一份好的工作,一定要先整理一份好的简历. ...

  4. Hexo之旅(四):文章编写技巧

    hexo 编写文章可以使用以下命令创建hexo new "文件名" #创建的文章会在_pots目录下文章的后缀名是以md命名的文件格式,遵循markdown语法,所以编写文章可以使 ...

  5. 【工匠大道】markdown使用技巧

    本文地址 提纲: 1. 概述 2. 常见技巧 3. 参考文档 1. 概述 常见的markdown的技巧,这里不再谈了,主要是自己感觉比较少见但有用的技巧. 2. 常见技巧   1)[空格]生成空格的效 ...

  6. MarkDown编写规范指南

    Markdown 编写规范指南 简介: Markdown的目标是实现「易读易写」,成为一种适用于网络的「书写语言」. 一份使用Markdown格式撰写的文件可以直接以纯文本发布,它的最大灵感来源其实是 ...

  7. Markdown 编写规范

    说明及目的 作为一个在博客园混迹了俩三年的人,一直在这里看别人的博客,现在准备开始写自己的博客,目的呢,就是一下几点吧: 项目过程中的历史经验教训积累记载,吃一堑长一智,不想在同一个坑掉进去好几次 学 ...

  8. 基于 Markdown 编写接口文档

    最近公司开发项目需要前后端分离,这样话就设计到后端接口设计.复杂功能需要提供各种各样的接口供前端调用,因此编写API文档非常有必要了 网上查了很多资料,发现基于Markdown编写文档是一种比较流行而 ...

  9. 【技巧汇总】eclipse中如何跳转到指定行

    技巧汇总 持续更新ing eclipse中如何跳转到指定行 ctrl+L

随机推荐

  1. 十五:JDBC学习入门

    一.JDBC相关概念介绍 1.1.数据库驱动 这里的驱动的概念和平时听到的那种驱动的概念是一样的,比如平时购买的声卡,网卡直接插到计算机上面是不能用的,必须要安装相应的驱动程序之后才能够使用声卡和网卡 ...

  2. [SWMM]软件启动不了,出现 “ RPC服务器不可用 ” 错误

    [问题]打开SWMM5.1软件时,初选"RPC服务器不可用"的错误 [解决]计算机管理--服务 设置Print Spooler服务状态为启动,并设置为自启动.

  3. DNS地址列表

    DNS测试工具(DNSBench):https://www.grc.com/dns/benchmark.htm DNS列表收集: Google DNS [URL]https://developers. ...

  4. 设置Sublime插件快捷键--实现CSS颜色选取

    安装插件ColorPicker 如果你经常要查看或设置颜色值,这个插件可以很方便地调用你本机的调色板应用.(译者扩充:)这是一个双向的功能,你既可以在调色板中选择一个颜色,然后按"确定&qu ...

  5. rabbitMq内存与磁盘分配问题

    在服务器上也可以改变配置文件修改内存 也可以使用命令进行分配: 相对内存:rabbitmqctl  set_vm_memory_hgih_waterwmark 0.4     使用时可以把这个0.4替 ...

  6. 使用栅格系统开发响应式页面——logo+nav实例

    小屏时: 中屏及以上时: <!DOCTYPE html> <html> <head> <meta charset="utf-8"> ...

  7. 「萌新指南」SOA vs. 微服务:What’s the Difference?

    实话实说,在我还没有实习之前,我是连 SOA 是啥都不知道的,只听说过微服务,毕竟微服务实在太火了,想不知道都难,我觉得实习的时候肯定也是微服务,进组之后发现是 SOA 架构,当时都懵了,看了很多文档 ...

  8. python入门-变量与数据类型

    1.命名规则 变量名只能包含字母.数字和下划线.但不能以数字打头. 变量名不能包含空格 不能与关键字冲突 变量名应尽量简短且具有描述性 2.字符串 python中引号括起的内容,其中引号可以为单引号或 ...

  9. 为开源项目 go-gin-api 增加后台任务模块

    目录 任务管理界面 (WEB) 任务调度器 任务执行器 小结 推荐阅读 任务管理界面 (WEB) 支持在 WEB 界面 中对任务进行管理,例如:新增任务.编辑任务.启用/禁用任务.手动执行任务 等. ...

  10. zabbix告警推送至个人微信

    文章原文 自从接触zabbix后,就一直想着怎么才能把告警推送到个人微信上.有这样的想法主要是个人微信的使用频率远远要比钉钉,企业微信,邮箱,飞书等使用频率要高.比如我,就遇到过在周末的时候,因为没有 ...