规范书写Markdown

作者: Josaber | 来源:发表于2016-11-29 11:59 被阅读132次

上一篇文章中,我们说Markdown在不同的编辑器中显示会有所不同,这就要求我们一定要规范书写Markdown,否则可能每个人看到的都不太一致。

下面是我见到的一些显示不一致:(以http://dillinger.io/和简书为例)

标题

Dillinger中,我们书写

##This is a title.

显示如下:


dillinger title

而在简书中,则能够正常显示:


jianshu title

发生了什么?


纳尼

而在Dillinger内,#与标题之间加入空格即可全部正常显示:

dillinger title

有序列表

一个有序列表的数字尽量以1起始的连续数字。这样一句话:

3. item 1.
8. item 2.

Dillinger中,是以3起始的连续列表:

dillinger list

而在简书中,我们得到的结果是以1开始的连续列表:


jianshu list

表格

这样一段话:

表格的书写相对复杂:
| Tables | Are | Complex | 
| -- |:--:| --:|
| left | center | right | 

Dillinger中可以得到正确的表格结果:

dillinger table

而在简书中得到的结果是这样的:

jianshu table 刚才发生了什么

在简书中,文字与表格之间加上空行就都可以正常显示了。

总结

一个适合的编辑器很重要,良好的书写风格更重要。

相关文章

  • markdown写作规范.md

    markdown 书写规范 适用于团队的统一 MarkDown 书写规范 由于 MarkDown 语法在细节的书写...

  • Markdown语法及书写规范

    Markdown语法及书写规范 引用文本:Markdown is a text formatting syntax...

  • 规范书写Markdown

    在上一篇文章中,我们说Markdown在不同的编辑器中显示会有所不同,这就要求我们一定要规范书写Markdown,...

  • ApiBlueprint在laravel框架中的使用

    说明 通俗一点就是一种接口规范,而且是使用markdown的,使用markdown的语法书写接口。 背景 目前和前...

  • 写作利器——Markdown语法指南基础篇

    前言 最近因为工作的原因,需要帮助组内制定文章书写规范,审查文章格式,目前文章均按照 Markdown 格式书写,...

  • 前端基本开发规范

    一般规范 HTML书写规范 CSS书写规范 JavaScript书写规范 一般规范 文件资源命名 资源(图片、js...

  • Markdown 编写规范

    Markdown 编写规范 此为前端开发团队遵循和约定的 Markdown 编写规范,意在提高文档的可读性。 说明...

  • 目录

    1.1 概述 2.1 文件命名规范 2.2 文件存放位置规范 3.1 HTML书写规范 4.1 CSS书写规范 4...

  • 2018-08-02-MarkDown使用教程

    MarkDown使用教程 参考: Markdown 书写风格指南 Markdown 语法说明 语法 1.标题 标题...

  • markdown语法指南

    Markdown 语法 Markdown 常用与书写博客,开发文档等‘.md’ 和 ‘.markdown’ 都是被...

网友评论

  • Oliver_Le:就是说在特殊符号和文本间都至少加上一个空格就可以在不同的解释器上正常显示了吧?🤔
    Josaber:@何疆乐 嗯嗯,谢谢
    Oliver_Le: @Joshuaber 我昨天写的时候也有遇到类似的情况,就是用---分割线的时候需要有个换行来隔开,要不有时也无法显示🤓,没有你细心,这个我就没想到要总结一下😳,总之赞一下👍
    Josaber:@何疆乐 嗯嗯
  • 6d96978eeefb:这是一个很有意思的问题。我赞成需要格外写空格的这种方式,因为markdown本身就应该具有良好的可读性。
    Josaber:@TW李鹏 嗯嗯,我也觉得加空格比较好,而且应该都能够识别加空格的标题

本文标题:规范书写Markdown

本文链接:https://www.haomeiwen.com/subject/bqmapttx.html