docs icon indicating copy to clipboard operation
docs copied to clipboard

【Docs】Markdown 格式的文档,表格和标题之间需要加空行

Open entired opened this issue 2 years ago • 0 comments

一、背景

飞桨官网的使用指南中,存在表格呈现形式错误问题。 例如Snipaste_2024-01-05_20-17-38

  • Markdown 格式的文档储存在GitHub中的 docs 仓库下,具体路径为 PaddlePaddle/docs/docs/guides

  • 每一个表格在Markdown 格式的文档中都有对应的描述

二、原因分析

Markdown 格式的文档中表格和标题之间缺失空行,官网渲染问题。

例如Snipaste_2024-01-05_20-18-53

三、解决方法

在表格和标题之间的位置添加空行。 例如Snipaste_2024-01-05_20-18-44 Snipaste_2024-01-05_20-17-22

  • 如上,添加空行后,渲染成功,表格形式正确。

entired avatar Jan 05 '24 12:01 entired