|
4 | 4 | Table of Contents *comment_repl_docs-table-of-contents* |
5 | 5 |
|
6 | 6 | 1. Comment-REPL.nvim |comment_repl_docs-comment-repl.nvim| |
| 7 | + - How does it work |comment_repl_docs-comment-repl.nvim-how-does-it-work| |
| 8 | + - Installation |comment_repl_docs-comment-repl.nvim-installation| |
| 9 | + - Configuration |comment_repl_docs-comment-repl.nvim-configuration| |
| 10 | + - Commands |comment_repl_docs-comment-repl.nvim-commands| |
7 | 11 | 2. Links |comment_repl_docs-links| |
8 | 12 |
|
9 | 13 | ============================================================================== |
10 | 14 | 1. Comment-REPL.nvim *comment_repl_docs-comment-repl.nvim* |
11 | 15 |
|
12 | 16 |
|
13 | 17 |
|
14 | | -A Neovim plugin for executing REPLs directly in your buffers and showing |
15 | | -results as comments. |
| 18 | +Execute code directly from your buffer and print the output as a comment. |
| 19 | + |
| 20 | + |
| 21 | +HOW DOES IT WORK *comment_repl_docs-comment-repl.nvim-how-does-it-work* |
| 22 | + |
| 23 | +Screenshot <doc/screenshot.png> |
| 24 | + |
| 25 | + |
| 26 | +INSTALLATION *comment_repl_docs-comment-repl.nvim-installation* |
| 27 | + |
| 28 | +Using lazy.nvim: |
| 29 | + |
| 30 | +>lua |
| 31 | + { |
| 32 | + 'atinylittleshell/comment-repl.nvim', |
| 33 | + opts = {}, |
| 34 | + } |
| 35 | +< |
| 36 | + |
| 37 | + |
| 38 | +CONFIGURATION *comment_repl_docs-comment-repl.nvim-configuration* |
| 39 | + |
| 40 | +See config.lua <lua/comment-repl/config.lua> for config schema and default |
| 41 | +values. |
| 42 | + |
| 43 | + |
| 44 | +COMMANDS *comment_repl_docs-comment-repl.nvim-commands* |
| 45 | + |
| 46 | +`:CommentREPLExecute` - Execute the code cell at the cursor and print the |
| 47 | +output as a comment. |
| 48 | + |
| 49 | +`:CommentREPLLog` - View logs from Comment-REPL.nvim. |
| 50 | + |
| 51 | +>lua |
| 52 | + -- By default the plugin will not enable any key bindings. |
| 53 | + -- Your can define your own keybind behavior like below. |
| 54 | + vim.keymap.set('n', '<leader>ce', '<cmd>CommentREPLExecute<CR>') |
| 55 | + vim.keymap.set('n', '<leader>cl', '<cmd>CommentREPLLog<CR>') |
| 56 | +< |
16 | 57 |
|
17 | 58 | ============================================================================== |
18 | 59 | 2. Links *comment_repl_docs-links* |
19 | 60 |
|
20 | | -1. *GitHub Workflow Status*: https://img.shields.io/github/actions/workflow/status/atinylittleshell/comment-repl.nvim/lint-test.yml?branch=main&style=for-the-badge |
| 61 | +1. *GitHub Workflow Status*: https://img.shields.io/github/actions/workflow/status/atinylittleshell/comment-repl.nvim/lint_test.yml?branch=main&style=for-the-badge |
21 | 62 | 2. *Lua*: https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua |
22 | 63 |
|
23 | 64 | Generated by panvimdoc <https://github.com/kdheepak/panvimdoc> |
|
0 commit comments