GitHub README表格渲染异常,寻求解决方法
我来帮你解决这个表格无法正常渲染的问题!你之前的写法是把整个表格内容挤在了一行里,GitHub的Markdown渲染器没办法正确识别这种格式,而且还有个小拼写错误,这才导致渲染出错。
给你修正后的正确代码,直接替换原来的内容就行:
## Request options | Option | Description | |----------------|-----------------------------------------------------------------------------| | url | Request url | | method | `'get'` \| `'post'` \| `'put'` \| `'delete'` - (default: `'get'`) | | headers | optional array: `[{name: string, value: string}]` | | body | Request body (any type) | | responseType | `'text'` \| `'json'` - (default: `'text'`) | | success | Success function - `function(data) { }` | | error | Error function - `function(err) { }` |
我做了这些调整:
- 把表格拆成了多行结构,表头、分隔线、每行数据各占一行,完全符合GitHub Markdown的表格规范;
- 修正了
responseType描述里的拼写错误defult为default; - 给表格加了二级标题,让整体文档结构更清晰;
- 调整了列分隔线的长度,让表格渲染后对齐更美观。
替换后,你的表格就能正常显示成规整的样式啦!
内容的提问来源于stack exchange,提问作者Igor Faoro




