Skip to content

Commit

Permalink
Update README for REditorSupport#465
Browse files Browse the repository at this point in the history
  • Loading branch information
kar9222 committed Nov 30, 2020
1 parent 522a21d commit 90bfeb9
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,47 @@ This extension contributes the following settings:
* `r.bracketedPaste`: For consoles supporting bracketed paste mode (such as Radian)
* `r.sessionWatcher`: Enable R session watcher (experimental)
* `r.rtermSendDelay`: Delay in milliseconds before sending each line to rterm (only applies if r.bracketedPaste is false)
* `r.rmarkdown.enableCodeLens`: Enable RMarkdown CodeLens, which are inline commands/buttons e.g. 'Run Chunk | Run Above' shown on the first line of each code chunk.
<details>
<summary>Details</summary>

* Click the buttons to run commands.
* Hover on the buttons to show tooltips.
* CodeLens commands are customizable via settings UI (Rmarkdown: Code Lens commands) or settings.json `r.rmarkdown.codeLensCommands`
</details>
* `r.rmarkdown.codeLensCommands`: Customize RMarkdown CodeLens, which are inline commands/buttons e.g. 'Run Chunk | Run Above' shown on the first line of each code chunk. <details>
<summary>Details</summary>
Available commands:

* `r.selectCurrentChunk`
* `r.runCurrentChunk`
* `r.runAboveChunks`
* `r.runCurrentAndBelowChunks`
* `r.runBelowChunks`
* `r.runAllChunks`
* `r.runPreviousChunk`
* `r.runNextChunk`
* `r.goToPreviousChunk`
* `r.goToNextChunk`
<br>

Customize both the commands AND its orders (that is, CodeLens respect user-specified orders). Default commands:
* `r.runCurrentChunk`
* `r.runAboveChunks`
* `<Add item...>`
</details>
* `r.rmarkdown.chunkBackgroundColor:` RMarkdown chunk background color in RGBA or RGB value.
<details>
<summary>Details</summary>
Defaults to rgba(128, 128, 128, 0.1). Leave it empty to disable it (use default editor background color). Reload VS Code after changing settings. Learn how to set colors: https://www.w3schools.com/css/css_colors_rgb.asp
<br><br>

Examples for syntax `rgba(<red>, <green>, <blue>, <alpha>)`:
* `rgba(128, 128, 128, 0.1)`
* `rgba(128, 128, 128, 0.3)`
* `rgba(255, 165, 0, 0.1)`
</details>


* Language server(developing [here](https://github.com/REditorSupport/languageserver))

Expand Down

0 comments on commit 90bfeb9

Please sign in to comment.