如何解决Markdown含超链接行触发MD013超80字符长度限制问题
调整方案
- 最优方案:使用Markdown原生引用式链接
无需拆分链接URL,仅需把长链接从正文抽离单独存放即可,完全不影响最终渲染效果,调整后正文行长度完全符合80字符限制:
正文行写法:
请参考[环境变量配置说明][env-config-ref]了解这些变量的更多信息。
在段落末尾或文档底部补充链接定义:
[env-config-ref]: https://github.com/orchestracities/ngsi-timeseries-api/blob/master/docs/manuals/admin/configuration.md#environment-variables
- 临时方案:单行忽略MD013规则
如果不想改动现有链接格式,可以给当前行加局部规则豁免注释,linter会跳过这一行的长度校验:
在当前行的上一行添加注释即可:
<!-- markdownlint-disable-next-line MD013 -->
也可以直接在当前行末尾加注释:
请参考[link](https://github.com/orchestracities/ngsi-timeseries-api/blob/master/docs/manuals/admin/configuration.md#environment-variables) for more info about those variables <!-- markdownlint-disable MD013 -->
内容的提问来源于stack exchange,提问作者damini chopra
相关产品推荐
相关产品推荐

