diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 200478f6..2e70aa0c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,7 +38,7 @@ make test-demo-config # run all demo configuration tests - Upload all `mov` files in the `assets` directory to Github by dragging them to a markdown file in the browser - Copy all the generated embedded video urls and paste in `uploaded_movs` array in the `make_video_markdown_files.sh` script - `./scripts/make_video_markdown_files.sh` -- `./scripts/make_adv_config_markdown_file.lua &> Advanced-Configuration.md` +- `./scripts/make_adv_config_markdown_file.lua &> Advanced-Configuration-Examples.md` ## Troubleshooting diff --git a/README.md b/README.md index c585bc9f..c3006be5 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Navigate your [Kitty](https://sw.kovidgoyal.net/kitty/) scrollback buffer to qui > [!TIP]\ > Expand each section under the [Features](#-features) section to see a demo. > -> Check out [Advanced Configuration](https://github.com/mikesmithgh/kitty-scrollback.nvim/wiki/Advanced-Configuration) for more demos! +> Check out [Advanced Configuration Examples](https://github.com/mikesmithgh/kitty-scrollback.nvim/wiki/Advanced-Configuration-Examples) for more demos! @@ -128,7 +128,7 @@ Navigate your [Kitty](https://sw.kovidgoyal.net/kitty/) scrollback buffer to qui ## Redesigned Plugin Configuration - The flag `--no-nvim-args` has been removed. The default behavior of kitty-scrollback.nvim no longer passes arguments to nvim making `--no-nvim-args` pointless. You can still pass arguments to nvim with the `--nvim-args` flag. - - `ksb_example` configurations have been removed and can no longer be referenced by name. These are used for testing and demo purposes. The configurations are still available as a reference at [./tests/examples.lua](./tests/examples.lua). + - `ksb_example` configurations have been removed and can no longer be referenced by name. These are used for testing and demo purposes. The configurations are still available as a reference at [./tests/example.lua](./tests/example.lua). - The command `KittyScrollbackGenerateKittens` and api `generate_kittens` no longer have an option to generate `ksb_example` configurations. - The command `KittyScrollbackGenerateKittens` no longer accepts the bang `!` modifier - The api `generate_kittens` signature removed the `all` parameter @@ -216,7 +216,7 @@ echo "require('kitty-scrollback').setup()" >> "$HOME/.config/nvim/init.lua" ## ✍️ Configuration > [!NOTE]\ -> The [Advanced Configuration](https://github.com/mikesmithgh/kitty-scrollback.nvim/wiki/Advanced-Configuration) section of the Wiki provides +> The [Advanced Configuration Examples](https://github.com/mikesmithgh/kitty-scrollback.nvim/wiki/Advanced-Configuration-Examples) section of the Wiki provides > detailed demos of each configuration option. ### Kitty diff --git a/tests/examples.lua b/tests/example.lua similarity index 100% rename from tests/examples.lua rename to tests/example.lua diff --git a/tests/kitty-scrollback/helpers.lua b/tests/kitty-scrollback/helpers.lua index 506ded8f..547bbcf9 100644 --- a/tests/kitty-scrollback/helpers.lua +++ b/tests/kitty-scrollback/helpers.lua @@ -586,7 +586,7 @@ M.init_nvim = function() vim.system({ 'rm', '-rf', nvim_config_dir }):wait() end vim.fn.mkdir(nvim_config_dir, 'p') - vim.uv.fs_copyfile(M.ksb_dir() .. [[tests/examples.lua]], nvim_config_dir .. '/init.lua') + vim.uv.fs_copyfile(M.ksb_dir() .. [[tests/example.lua]], nvim_config_dir .. '/init.lua') end return M