专栏首页Flutter入门到实战开发工具总结(5)之Markdown语法图文全面详解及其工具介绍

开发工具总结(5)之Markdown语法图文全面详解及其工具介绍

版权声明:本文为博主原创文章(少量文字参考他人博文,已加上引用说明),未经博主允许不得转载。https://www.jianshu.com/p/c0a2897ad4eb

转载请标明出处: https://www.jianshu.com/p/c0a2897ad4eb 本文出自 AWeiLoveAndroid的博客


【前言】写过博客或者github上面的文档的,应该知道Markdown语法的重要性,不知道的朋友们也别着急,一篇博客轻松搞定Markdown语法。话说这个语法超级简单,一看就会,不信你点开看看。

一、快捷键

加粗 Ctrl + B
斜体 Ctrl + I
引用 Ctrl + Q
插入链接 Ctrl + L
插入代码 Ctrl + K
插入图片 Ctrl + G
提升标题 Ctrl + H
有序列表 Ctrl + O
无序列表 Ctrl + U
横线 Ctrl + R
撤销 Ctrl + Z
重做 Ctrl + Y

二、基本语法

(一)对字体设置斜体、粗体、删除线,语法如下:

*这里是文字*
_这里是文字_
**这里是文字**
***这里是文字***
~~这里是文字~~

(二)分级标题,两种写法,如下所示:

写法1:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题  这个写法和 **文字**效果是一样的
写法2:
这是一个一级标题
============================

或者

二级标题
--------------------------------------------------

(三)链接

(1)插入本地图片链接

语法规则,有两种写法:

插入本地图片链接两种写法

注意:这个图片描述可以不写。

示例图如下:

(2)插入互联网上图片

语法规则:

插入互联网上图片语法规则

注意:这个图片描述可以不写。

示例如下:

(3)自动连接

Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱,只要是用<>包起来, Markdown 就会自动把它转成链接。也可以直接写,也是可以显示成链接形式的

例如:

(四)分割线

你可以在一行中用三个以上的星号(*)、减号(-)、底线(_)来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。

(五)代码块

对于程序员来说这个功能是必不可少的,插入程序代码的方式有两种,一种是利用缩进(tab), 另一种是利用英文“`”符号(一般在ESC键下方,和~同一个键)包裹代码。

(1)代码块:缩进 4 个空格或是 1 个制表符。效果如下:
#include <stdio.h>
int main(void)
{
    printf("Hello world\n");
}
(2)行内式:如果在一个行内需要引用代码,只要用反引号`引起来就好(Esc健)
(3)多行代码块与语法高亮:在需要高亮的代码块的前一行及后一行使用三个单反引号“`”包裹,就可以了。

示例如下:

(4)代码块里面包含html代码

在代码区块里面, & 、 < 和 > 会自动转成 HTML 实体,这样的方式让你非常容易使用 Markdown 插入范例用的 HTML 原始码,只需要复制贴上,剩下的 Markdown 都会帮你处理。

注意:简书代码块里不支持html。

示例如下:

(六)引用

在被引用的文本前加上>符号,以及一个空格就可以了,如果只输入了一个>符号会产生一个空白的引用。

(1)基本使用

使用如下图所示:

引用的使用示范

(2)引用的嵌套使用

使用如图所示:

引用嵌套

(3)引用其它要素

引用的区块内也可以使用其他的 Markdown 语法,包括标题、列表、代码区块等。

使用如图所示:

引用里面使用其他元素

(七)列表

(1)无序列表

使用 *,+,- 表示无序列表。 注意:符号后面一定要有一个空格,起到缩进的作用。

无序列表

(2)有序列表

使用数字和一个英文句点表示有序列表。 注意:英文句点后面一定要有一个空格,起到缩进的作用。

有序列表

(3)无序列表和有序列表同时使用
(4)列表和其它要素混合使用

列表不光可以单独使用,也可以使用其他的 Markdown 语法,包括标题、引用、代码区块等。

注意事项:列表中包含多行代码块,需要另起一行,否则不生效。

使用示例如下图:

(5)注意事项

在使用列表时,只要是数字后面加上英文的点,就会无意间产生列表,比如2017.12.30 这时候想表达的是日期,有些软件把它被误认为是列表。解决方式:在每个点前面加上\就可以了。如下图所示:

(八)表格

表格的基本写法很简单,就跟表格的形状很相似:

表格的基本使用

表格对齐方式:我们可以指定表格单元格的对齐方式,冒号在左边表示左对齐,右边表示有对齐,两边都有表示居中。

如下图所示:

表格对齐


三、常用技巧

(一)换行

方法1: 连续两个以上空格+回车
方法2:使用html语言换行标签:<br>

(二)缩进字符

不断行的空白格 &nbsp; 或 &#160;
半角的空格 &ensp; 或 &#8194;
全角的空格 &emsp; 或 &#8195;

markdown缩进语法

(三)如何打出一些特殊符号

  • (1)对于 Markdown 中的语法符号,前面加反斜线\即可显示符号本身。

示例如下:

如何打出一些特殊符号

  • (2)其他特殊字符,示例如下:

其他特殊字符

想知道字符对应的Unicode码,可以看这个网站:https://unicode-table.com/cn/

附上几个工具对特殊字符的支持的对比图:

工具或网站

是否特殊字符

简书

MarkDownPad

否(不知道付费版是否支持)

有道云笔记

zybuluo.com

(四)字体、字号与颜色

Markdown是一种可以使用普通文本编辑器编写的标记语言,通过类似HTML的标记语法,它可以使普通文本内容具有一定的格式。但是它本身是不支持修改字体、字号与颜色等功能的!

CSDN-markdown编辑器是其衍生版本,扩展了Markdown的功能(如表格、脚注、内嵌HTML等等)!对,就是内嵌HTML,接下来要讲的功能就需要使用内嵌HTML的方法来实现。

字体,字号和颜色编辑如下代码

<font face="黑体">我是黑体字</font>
<font face="微软雅黑">我是微软雅黑</font>
<font face="STCAIYUN">我是华文彩云</font>
<font color=#0099ff size=7 face="黑体">color=#0099ff size=72 face="黑体"</font>
<font color=#00ffff size=72>color=#00ffff</font>
<font color=gray size=72>color=gray</font>

Size:规定文本的尺寸大小。可能的值:从 1 到 7 的数字。浏览器默认值是 3

具体颜色分类及标记请看下表:

颜色分类及标记对照表

(五)链接的高级操作(这个需要掌握一下,很有用)

(1)行内式。这个在上文第二条基本语法链接这个小节已经过,这里就不继续讲解了。
(2)参考式链接。
在文档要插入图片的地方写![图片或网址链接][标记],在文档的最后写上[标记]:图片地址 “标题”。(最后这个"标题"可以不填写)

示例如下:

(3)内容目录

一般在文章开头打上[TOC] 就可以显示全文内容的目录结构。

【注意:】简书不支持[TOC]目录结构。

  • 下面讲一下github的目录结构是怎么做的,每个标签要对应标题名称:

Github的目录结构

(4)锚点

锚点其实就是页内超链接。比如我这里写下一个锚点,点击回到目录,就能跳转到目录。 在目录中点击这一节,就能跳过来。

语法说明:

在你准备跳转到的指定标题后插入锚点{#标记},然后在文档的其它地方写上连接到锚点的链接。

github支持锚点跳转,这里说一下锚点在github的使用:

简书中的 锚点 使用如下图所示:

注意:在简书中使用锚点时,点击会打开一个新的当前页面,虽然锚点用的不是很舒服,但是可以用注脚实现这个功能。

(5)注脚

语法说明:

在需要添加注脚的文字后加上脚注名字[^注脚名字],称为加注。 然后在文本的任意位置(一般在最后)添加脚注,脚注前必须有对应的脚注名字。

示例如下:

image.png

注意事项: (1)脚注自动被搬运到最后面,请到文章末尾查看,并且脚注后方的链接可以直接跳转回到加注的地方。 (2)由于简书不支持锚点,所以可以用注脚实现页面内部的跳转。

(六)背景色

Markdown本身不支持背景色设置,需要采用内置html的方式实现:借助 table, tr, td 等表格标签的 bgcolor 属性来实现背景色的功能。举例如下:

<table><tr><td bgcolor=orange>背景色是:orange</td></tr></table>

效果图

(七)emoji表情符号

emoji表情使用:EMOJICODE:的格式,详细列表可见 https://www.webpagefx.com/tools/emoji-cheat-sheet/

当然现在很多markdown工具或者网站都不支持。

下面列出几个平台的对比:

工具或网站

是否支持emoji表情符号

简书

MarkDownPad

否(不知道付费版是否支持)

有道云笔记

zybuluo.com

github


四、高端用法

目前我用过的简书,CSDN,包括markdownPad软件都不支持下面这些功能,有一个在线网站https://www.zybuluo.com/mdeditor 可以支持。

(一)使用LaTex数学公式

  • 1.行内公式:使用两个”$”符号引用公式: $公式$
  • 2.行间公式:使用两对“$$”符号引用公式: $$公式$$

示例

具体可以参考 markdown编辑器使用LaTex数学公式

(二)流程图

这里简单介绍一下流程图的语法,仅作为了解,如下图所示:

(三)制作一份待办事宜----Todo 列表

(四)绘制 序列图

(五)绘制 甘特图


五、简书如何设置Markdown

默认的简书写博客是富文本模式的,想要设置成Markdown,可以这样设置:

(一)进入博客主页,点击头像旁边的倒三角符号,选择 "设置"

(二)选择“基础设置”,“常用编辑器”,选择 Markdown,点击保存


六、Markdown工具

(一)markdownpad软件,就是利用markdown语言写笔记的。官网下载地址: http://markdownpad.com/

软件安装之后的示意图如下图所示:

(二)MarkEditor软件,它是mac系统上面使用的软件,收费的。官网下载地址: http://markeditor.com/app/markeditor 具体介绍使用有人写了博文,这里不再重复,请看 MarkEditor——也许是最强大Markdown写作软件(集美貌与才华于一身)

(三)有道云笔记支持markdownpad语法。官方网址:http://note.youdao.com/ 它有在线网页版以及PC端可以下载。当然有道云笔记也支持html语法。

网页版使用markdown示例图如下:

(四)在线编辑markdown https://www.zybuluo.com/mdeditor

(五)在线md排版编辑网站,可以支持自定义样式排版 http://md.aclickall.com/

【注】其他工具请看下文图中的对比


七、不同平台功能对比

(一)Windows平台的下的免费的桌面版的Markdown编辑器对比图(截至2016/2/10) 图片来源参考: https://www.zhihu.com/question/19637157

Windows平台的下的免费的桌面版的Markdown编辑器对比图

(二)


八、使用MarkdowPad软件遇到的坑

(一)Awesomium.Windows.Controls.WebControl’

解决方法:修改注册表:

按Win+R运行regedit,依次选择:
HKEY_LOCAL_MACHINE/SYSTEM/CurrentControlSet/Control/Lsa/FipsAlgorithmPolicy/Enabled
然后修改值为0就可以了。

如果不能解决,下载一个Awesomium软件,然后再按上述方法修改注册表试试看。

(二)弹窗显示的内容是这样的: An error occurred with the HTML rendering component. This issue may be fixed by installing a missing component.Would you like to learn more?

解决方法:修改注册表:

按Win+R运行regedit,依次选择:
HKEY_LOCAL_MACHINE/SYSTEM/CurrentControlSet/Control/Lsa/FipsAlgorithmPolicy/Enabled
然后修改值为0就可以了。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 推特开源的Serial,轻量级,快速的json解析框架

    你还在用Gson,fastjson吗?最近几个月推特开源了她们的json解析和序列化框架 Serial,这是一个轻量级框架,操作起来也很简单。下面简单的介绍一下...

    AWeiLoveAndroid
  • 开发工具总结(1)之图文并茂全面总结上百个AS好用的插件(上)

    俗话说得好,工欲善其事,必先利其器。做开发时间长了,总想找一些快捷方法,只有拥有好用的工具,才能节省开发时间,提高工作效率。我就是一个 追(喜)求(欢)高(偷)...

    AWeiLoveAndroid
  • Bson类似于Protocol Buffer的数据形式,比json更轻量级更高效

    BSON是Binary JSON的缩写,是一种类json的一种二进制形式的存储格式。 它和JSON一样,支持内嵌的文档对象和数组对象,但是BSON在JSON基...

    AWeiLoveAndroid
  • django从sqlite切换到mysq

    'Did you install mysqlclient or MySQL-python?' % e django.core.exceptions.Improp...

    py3study
  • 记一次被DDoS敲诈的历程

    之前一个蜀国的朋友业务被DDOS攻击,业务服务被机房断网,客户单流失有经济损失,这篇具体说的就是这件事情。

    糖果
  • 按需付费:使用云计算的正确姿势

    原文编者按:正文开始前,首先允许我介绍下作者,因为这篇文章让我对我司的这位北大学霸又有了新的认识,他的手机移动电源都是在公司充好电才带回去,简直太会过日子了。。...

    静一
  • Thinkphp5.0 框架的请求方式与响应方式分析

    本文实例讲述了Thinkphp5.0 框架的请求方式与响应方式。分享给大家供大家参考,具体如下:

    砸漏
  • Oracle函数sys_connect_by_path用法

    sys_connect_by_path函数是为了配合递归查询的函数,递归查询可以参考我之前的博客:https://blog.csdn.net/u01442739...

    SmileNicky
  • Markdown语法讲解及MWeb使用教程

    写了一个月的博客,忽然感觉Markdown编辑器比较好用,于是就下载了一个本地的Markdown编辑软件学习了一下,刚好软件里自带了一篇英文的指示文档,顺便翻译...

    我是十三
  • 扩展卡尔曼滤波EKF与多传感器融合

    Extended Kalman Filter(扩展卡尔曼滤波)是卡尔曼滤波的非线性版本。在状态转移方程确定的情况下,EKF已经成为了非线性系统状态估计的事实标准...

    用户1147754

扫码关注云+社区

领取腾讯云代金券