diff --git a/README.md b/README.md index 4775da924..2459a093c 100644 --- a/README.md +++ b/README.md @@ -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 + + * 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` +
+* `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 + Available commands: + + * `r.selectCurrentChunk` + * `r.runCurrentChunk` + * `r.runAboveChunks` + * `r.runCurrentAndBelowChunks` + * `r.runBelowChunks` + * `r.runAllChunks` + * `r.runPreviousChunk` + * `r.runNextChunk` + * `r.goToPreviousChunk` + * `r.goToNextChunk` +
+ + Customize both the commands AND its orders (that is, CodeLens respect user-specified orders). Default commands: + * `r.runCurrentChunk` + * `r.runAboveChunks` + * `` +
+* `r.rmarkdown.chunkBackgroundColor:` RMarkdown chunk background color in RGBA or RGB value. +
+ Details + 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 +

+ + Examples for syntax `rgba(, , , )`: + * `rgba(128, 128, 128, 0.1)` + * `rgba(128, 128, 128, 0.3)` + * `rgba(255, 165, 0, 0.1)` +
+ * Language server(developing [here](https://github.com/REditorSupport/languageserver))