如何在vscode扩展的README.md中插入表?

时间:2019-02-13 07:29:35

标签: visual-studio-code doc readme

我想在README.md中插入扩展名vscode的表。我的代码如下:

* some title

  | words              | transform to | keepUpperCase is false | keepUpperCase is true |  
  |--------------------|--------------|------------------------|-----------------------|  
  | "XML HTTP request" | pascalCase   | `XmlHttpRequest`       | `XMLHTTPRequest`      |  
  | "new customer ID"  | camelCase    | `newCustomerId`        | `newCustomerID`       |  

github和Visual Studio市场概述中的结果符合预期,但是vscode打开的扩展概述中的结果如下:

  • 一些标题

    |字|转换为| keepUpperCase为假| keepUpperCase为真|
    | -------------------- | -------------- | ------------- ----------- | ----------------------- |
    | “ XML HTTP请求” | pascalCase | XmlHttpRequest | XMLHTTPRequest |
    | “新客户ID” | camelCase | newCustomerId | newCustomerID |

当我如下更改代码时:

* some title

| words              | transform to | keepUpperCase is false | keepUpperCase is true |  
|--------------------|--------------|------------------------|-----------------------|  
| "XML HTTP request" | pascalCase   | `XmlHttpRequest`       | `XMLHTTPRequest`      |  
| "new customer ID"  | camelCase    | `newCustomerId`        | `newCustomerID`       |  

该表将按预期方式呈现。但是我会这样丢失文档层次结构。

2 个答案:

答案 0 :(得分:1)

我终于用内联html解决了这个问题:

* some title

  <table>
    <thead>
      <tr>
        <th>words</th>
        <th>transform to</th>
        <th>keepUpperCase is false</th>
        <th>keepUpperCase is true</th>
      </tr>
    </thead>
    <tbody>
        <tr>
            <td>"XML HTTP request"</td>
            <td>pascalCase</td>
            <td><code>XmlHttpRequest</code></td>
            <td><code>XMLHTTPRequest</code></td>
        </tr>
        <tr>
            <td>"new customer ID"</td>
            <td>camelCase</td>
            <td><code>newCustomerId</code></td>
            <td><code>newCustomerID</code></td>
        </tr>
    </tbody>
  </table>

答案 1 :(得分:0)

Markdown有不同的口味,每种口味的呈现方式都不同。

Visual Studio Code的内置Markdown引擎使用CommonMark中提到的https://code.visualstudio.com/docs/languages/markdown#_does-vs-code-support-github-flavored-markdown Markdown规范:

  

VS Code是否支持GitHub Flavored Markdown?

     

否,VS Code使用CommonMark库定位markdown-it Markdown规范。 GitHub正在朝着CommonMark规范迈进,您可以   阅读此update

Extending the Markdown preview中所述,如果要针对特定​​平台(在您的情况下为Github),则可以安装扩展程序,以更改内置的markdown预览以匹配目标平台的样式。例如,您可以安装建议的Markdown Preview Github Styling,以便预览与Github中的预览相同。