cerxes/babel
3
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Normalize options sections in docs [skip ci] (#5244)

Browse Source
This commit is contained in:
Brian Ng
2017-01-31 07:46:01 -06:00
committed by Henry Zhu
parent 2104ab6c44
commit 160bd3924b
11 changed files with 108 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
packages/babel-code-frame/README.md
View File

@@ -35,9 +35,26 @@ If the column number is not known, you may pass `null` instead.
## Options
name | type | default | description
-----------------------|----------|-----------------|------------------------------------------------------
highlightCode | boolean | `false` | Syntax highlight the code as JavaScript for terminals
linesAbove | number | 2 | The number of lines to show above the error
linesBelow | number | 3 | The number of lines to show below the error
forceColor | boolean | `false` | Forcibly syntax highlight the code as JavaScript (for non-terminals); overrides highlightCode
### `highlightCode`
`boolean`, defaults to `false`.
Toggles syntax highlighting the code as JavaScript for terminals.
### `linesAbove`
`number`, defaults to `2`.
Adjust the number of lines to show above the error.
### `linesBelow`
`number`, defaults to `3`.
Adjust the number of lines to show below the error.
### `forceColor`
`boolean`, defaults to `false`.
Enable this to forcibly syntax highlight the code as JavaScript (for non-terminals); overrides `highlightCode`.