Github 和 npm table markdown 之间的区别

Question

我的 readme.md Markdown table 在 npm 上正确显示，但在 GitHub 上显示不正确。

这是 table 降价：

   Attributes  | Field type | value |  description
- | - | - | -
required | `*`  | boolean`(default=false)` | check if field has a value if set true.
  requiredPhrase | `*`  | string`(default=This field is required.)` | error shown when field is required and empty.
name  | `*`  | string | a unique string in form, on submitting the form you can access a field value by values.`<name>`
placeholder  | `*`  | string`(default=null)` | inputs placeholder.
defaultValue | `*`  | any`(default=null)` | in case of editing forms pass current values via `defaultValue`.
 maxLength | `text`, `number` and `password` | number`(default=null)` | maximum value length.
  maxLengthErrorPhrase | `text`, `number` and `password` | string`(default=This field accepts <maxLength> characters.)` | error shown when maxLength is crossed.
   multiSelect | `select`| boolean`(default=false)` | set true if select can have more than one values.
   selectHandle | `select` | component`(default=an ungly css-made triangle)`, example: `<i className="ion-ios-arrow-down` (which needs ionicons) | this option is for changing the select box handle component.   
   options | `select`, `radio` | array of objects with `label` and `value` | choices for select input and radio group.
   checkboxLabel| `checkbox` | string`(default:'')`| checkbox label.
   mustBeCheckedPhrase| `checkbox` | string`(default:'This field must be checked.')`| error shown when checkbox is required and not checked.

也许 GitHub 使用不同的 Markdown？

Answer 1

要么添加前导管道：

| Attributes  | Field type | value |  description
| - | - | - | -
| required | `*` | boolean`(default=false)` | check if field has a value if set true.
| requiredPhrase | `*` | string`(default=This field is required.)` | error shown when field is required and empty.

或使用两个（或更多）连字符而不是一个连字符，这样它们就不会被解析为项目符号：

Attributes  | Field type | value |  description
-- | -- | -- | --
required | `*` | boolean`(default=false)` | check if field has a value if set true.
requiredPhrase | `*` | string`(default=This field is required.)` | error shown when field is required and empty.

我还建议去掉锯齿状的前导空格，以提高原始 Markdown 的可读性。

Github 和 npm table markdown 之间的区别

Difference between Github and npm table markdown

markdown

github-flavored-markdown