Markdown使用问题及解决办法

背景介绍

目前来看,我是一位专业的打杂人员,维护网络、文档、共享中心、随时听候大师兄的调遣,这样使得本来很惬意的生活多了点凌乱,少了点自由,多了点忙碌,少了点懒散。更多的时间则集中在了解更多的内容,而不是集中在某一个点上进行学习,这样可能就会产生丢三落四,做这忘那的问题,这就需要有一个很好的计划才行,这些罢笔不提。大概半个月之前,大师兄发现自己N年前做的事情,写了文档,但是现在还有很多同学在重复走大师兄当年的路,自己摸索,自己解决问题,不仅烦躁,苦逼,而且节奏慢,效率低,这才引出维护文档的问题。

为什么采用md格式

首先大师兄提出两点要求:

  1. 有版本更新记录
  2. 可以多人维护

这不就是git嘛,使用git当然要用文本方式了,再加上心中有个对md的大概了解,所以就提议采用md格式来管理文档,就此开始了md的不归路。

markdown遇到的问题

二级列表嵌套问题

刚刚改写车载台项目文档时遇到,只需要在第一级列表行开头加上一个tab就可以解决问题,示例如下:

1
2
3
4
5
- 这是第一级列表第一行
- 这是第一级列表第二行
- 这是第二级列表第一行
- 这是第二级列表第二行
- 这是第一级列表第三行

显示效果如下:

  • 这是第一级列表第一行
  • 这是第一级列表第二行
    • 这是第二级列表第一行
    • 这是第二级列表第二行
  • 这是第一级列表第三行

如何存放图片的问题

虽然md对图片的支持已经很好用,但是和word比,还是不够方便,如果把图片放到git里也不是很容易管理大量的图片,所以这里借鉴了github-pages常用的解决方案,采用七牛云存储来管理图片,每张图片给出一个确定的链接,也方便md文档的转移。

七牛云存储免费用户额度如下:

  • 存储空间1GB
  • 每月下载流量1GB
  • 创建1个空间
  • 每月Put请求1万次
  • 每月Get请求10万次
  • 仅支持富媒体上传

显然免费用户已经够我们使用,也可能得到固定图片链接地址的优势。

图片引用示例如下:

图片引用示例

中文段缩进问题

由于md是老外的作品,而英文是没有段首缩进这么一说的,所以md也想当然的不支持段首缩进,再者,可能也是因为英文无段首缩进,所以md对空白不敏感,所以这里就需要解决这个问题;

现在有两种方案:

圆角空格代替空格实现段首缩进

可能是因为圆角空格和空白的ASCII都不一样,这样md并不认为圆角空格是空白,利用这个原理可以很容易的实现段首缩进,示例如下

  这一段前采用圆角空格实现了段首缩进

插入html标签

md是一门标记语言,并不是用来取代html语言,所以它只是为了方便我们的使用而产生的,所以md从出生开始就支持html标签来优化md的显示效果,对于段首缩进问题,我所发现的是采用pre标签来实现,我对html不熟,可能还会有其他标签,有待于指出更新完善。

pre标签实现段首缩进示例:

这一段前采用pre标签实现了段首缩进


### 文章内插入脚注的问题

暂时没有解决。(很多markdown版本对脚注有支持,但是markdown基本功能是包含这一项功能的,github pages帮助里也没有提到这一项)

## markdown进阶

### 调整表格的宽度

markdown中的表格单元格的宽度都是等宽的,如果某一列所要写的内容比较多,表格就会特别的丑,所以需要设置下某一列的宽度,在markdown中加入`CSS`代码可以解决这个问题,例如将第一行宽度设置为350px:

1
2
3
4
5
<style> table th:nth-of-type(1) { width: 350px; } </style>

表头 | 属性 | 属性
---- | ---- | ------
项目名称项目名称项目名称项目名称 | 数值1 | 数值2
显示效果: 表头 | 属性 | 属性 ---- | ---- | ------ 项目名称项目名称项目名称项目名称 | 数值1 | 数值2 > nth-of-type(NUM):NUM表示设置的是第几列; > 如果是第一列也可以用`first-of-type`来取代`nth-of-type(1)` > 具体的可以参考这里:[th参考链接](http://www.w3school.com.cn/cssref/css_selectors.asp) **注意:**`
Brick wechat
扫一扫,用手机看更方便(^ ◕ᴥ◕ ^)