Skip to content

Update README for #465 #480

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
renkun-ken merged 1 commit into from
Dec 1, 2020
Merged

Update README for #465 #480

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions README.md
View file
Open in desktop
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