GFM操作 & 遇到的问题及解决方案

  GitHub 使用的是 “ GitHub Flavored Markdown ” ,简称GFM,有site-in issues,comments,pull requests等功能,它与标准的Markdown有一些区别,并增加了些新的扩展功能

  Github上的一篇高star语法讲解:README文件语法解读,即Github Flavored Markdown语法介绍。但都是讲一些很基础的。像实际问题中遇到的四重列表嵌套外带多层中插入注释,这里面并没有讲到。

-

Problem

Solution

0

我把大段文段复制到MarkdownEditor.io上进行重新编辑,再贴回github修改框后,发现格式依然是乱的,只不过由一种乱法变成了另一种乱法。

上网去查,发现GFM是一种独立于Markdown的语法。在一些语法的书写上,比如列表多重嵌套,并在其中多层插入注释字段时,语法与普通的 Markdown 语法还是有很大的差别的。之前学习Markdown的时候,虽然知道Markdown有很多变种语法,但是写的都只是一些简单的嵌套,并没有涉及三四重以上的嵌套,也没有在嵌套中插入注释,所以一直没觉得GFM和Mrakdown有什么区别。直到碰上了具体情况需要这种的复杂书写时,才暴露出了这个问题。

1

用GFM书写简单语法时,用两个空格键就能代替Tab。空格键和Tab键常常可以多打也没关系。于是我在多重嵌套的时候依然这么干。。然后就悲剧了。。T T

在书写GFM时想要不犯错,缩进必须要严格采用Tab键(Tab键会等于超级多个空格,远不止四个)。Tab键既不可以多打也不可以少打。

2

列表多重嵌套时,对其中某一项插入注释

如果注释句要与被注释的句项都是4个#字体大小的(注意:正常大小字体也会被当成前面加了4个#来识别),为了让转换器识别出这是两句从属关系的语句,则插入之前,该注释句要与被注释的句项间隔至少一行;如果注释句要与被注释的句项字体大小不一样,则可以不用空行。但是不论是哪种情况,该注释句都必须要比被注释的句项恰好多空一个Tab(只管敲Tab就好了,就算觉得每个Tab离得再宽,编辑器也会自动帮你识别清楚的;但是对列表树根进行注释时,该注释句 却不能 比被注释的句项多空一个Tab。。。没搞懂为什么会这样 T T )

3

某些时候会把语法符号也跟着显示出来,或者一些语法转换成h5时错乱

可能是输入时,输入状态还是处于“中文”状态下。像空格,在“中文”状态下打出的一个空格距离和“英文”状态下打出的一个空格距离是不一样的。

4

因为Markdown系列的语法最后要被转换成h5,所有可以在Markdown系列(包括GFM)文本中插入h5字段,以作为Markdown系列语法的补充,来显示出更多的效果。然而当我想在GFM写的表格中的某个空里,插入h5的代码写的列表时,发现怎么也写不出这个效果。

h5代码 与 GFM代码 至少间隔 一行。也就是说,Markdown系列文本的原语法字段和插入的h5字段是分开来识别的,其中前者会被转换。因而h5字段只能在全局文本的基础上插入,并不可以在原语法字段的代码中强行插入。

5

写语法时,经常会牵一发而动全身,语法错误累积多了之后,会给修改造成很大麻烦。因为任何一种显示出来的错误,都可能是多个语法错误的综合作用结果。

规范书写很重要!语法正确要从娃娃抓起!!

6

有时候在修改代码时,改了一个地方好像把前面字段的显示改过来了,改到后面又发现前面字段的显示重新乱了。或者是感觉后面字段的语法完全没问题,但是就是显示出来不对(比如 #### 会一直被直接显示出来,或者三级列表项会一直被显示为二级列表项)

还是因为语法错误累积得太多,牵一发而动全身。还是那句,规范书写很重要!

7

连续7个 # 后,无法转换成更小号的字体

标题字体 相当于前面加 2 个 #;正常字体 相当于前面加 4 个 #;灰色注释小字体 相当于前面加6个 #;但是前面加7个以上(含7个) # 就转换不了了

8

输入时,发现刚刚从句首输入的一个单字符,闪了一下又消失了

把前一个句法的末位字符改成以’英文输入状态’输入

9

表格里面的字体重叠

表格最后一行要和接在表格后面的内容空两行或两行以上



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

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏landv

斑马标签打印机蛋疼的打印错误处理方法

默认自动检测的纸张,打印预览的时候没有问题,但是打印出来的效果,就一小块,打印不全。这个蛋疼的问题,可能和操作系统有关系,win10打印的时候没有问题,win7...

11020
来自专栏小樱的经验随笔

php开发文章发布示例(正则表达式实例开发)

存档: post.php 1 <form method="post" action="viewthread.php" target="_blank"> 2 ...

33350
来自专栏python3

scrapy选择器xpath

Scrapy提取数据有自己的一套机制,它们被称作选择器(seletors),通过特定的Xpath或者css表达式来"选择"html文件中的某个部分。

6610
来自专栏大史住在大前端

javascript基础修炼(10)——VirtualDOM和基本DFS

Virtual-DOM,即虚拟DOM树。浏览器在解析文件时,会将html文档转换为document对象,在浏览器环境中运行的脚本文件都可以获取到它,通过操作do...

9110
来自专栏hrscy

iOS 9 Storyboard 教程(一下)

你可以直接从storyboard编辑器中,使用原型cell你可以很容易的为你的tableViewCell设计一套自定义的布局.

61520
来自专栏Golang语言社区

从web图片裁剪出发:了解H5中的Blob

刚开始做前端的时候,有个功能卡住我了,就是裁剪并上传头像。当时两个方案摆在我面前,一个是flash,我不会。另一个是通过iframe上传图片,然后再上传坐标由后...

54470
来自专栏移动开发之家

Flutter完整开发实战详解(一、Dart语言和Flutter基础)

 在如今的 Fultter 大潮下,本系列是让你看完会安心的文章。本系列将完整讲述:如何快速从0开发一个完整的 Flutter APP,配套高完成度 Flut...

1.3K30
来自专栏移动开发之家

Flutter完整开发实战详解(一、Dart语言和Flutter基础)

 在如今的 Fultter 大潮下,本系列是让你看完会安心的文章。本系列将完整讲述:如何快速从0开发一个完整的 Flutter APP,配套高完成度 Flut...

26020
来自专栏python学习路

六、BeautifulSoup4------自动登录网站(手动版)

每天一个小实例:(按照教学视频上自动登录的网站,很容易就成功了。自已练习登录别的网站,问题不断) 这个自己分析登录boss直聘。我用了一下午的时间,而且还是手动...

55950
来自专栏未闻Code

正则表达式re.sub替换不完整的问题现象及其根本原因

问题的起因来自于一段正则替换。为了从一段HTML代码里面提取出正文,去掉所有的HTML标签和属性,可以写一个Python函数:

14720

扫码关注云+社区

领取腾讯云代金券