标签: Markdown
-
README.md 在 VS Code 中显示正常,但在 GitHub 上格式错乱。经排查,原因是缺少代码块标记导致内容被压平,以及标题未用空行隔开,不符合 GitHub Markdown 规范。通过重新整理文档,添加正确的代码块符号并调整空行,使格式符合标准后再次提交,GitHub 上的显示恢复了工整。
-
本文针对 Markdown 文档中包含中文标点符号的锚点无法跳转的问题进行了排查。通过检查渲染后的 HTML 语句,发现生成的 id 属性中包含标点符号。经测试,在修改 Markdown 源码并移除锚点中的标点符号后,网址形式恢复正常,且可以成功跳转至对应位置。结论表明移除中文标点可解决该跳转失效问题。
-
本文解决了 Markdown 文档中点击锚点无法跳转的问题。作者在 PhpStorm 中发现锚点无法解析,通过 IDE 自动完成修正了链接。尽管在编辑器中仍提示无法解析,但调整锚点包含具体文本后,在 GitLab 平台点击锚点已能成功跳转至对应位置。文章最终建议锚点名称尽量使用英文以提升语义化。
-
在 ShowDoc 的 Markdown 编辑中,当输入包含连续多个星号的文本如 30 * 24 * 3600 时,显示结果会异常丢失星号。文章演示了通过在每个星号前添加转义反斜杠,将内容修改为 30 \* 24 \* 3600,最终成功使所有星号按原样正常显示,解决了符号被错误渲染的问题。
-
本文探讨了从 Rap 迁移至 ShowDoc 的接口文档编写设计,分析了两者在 JSON 导入功能及参数层级展示上的差异。鉴于 ShowDoc 默认模板仅支持一级参数且无 JSON 导入功能,文章排除了京东文档中高难度的合并单元格方案,转而定制了支持多级参数的互动运营 API 接口模板,最终验证其显示效果符合预期,解决了多级参数的展示需求。
