From ee293e9b97d292c382c4c142c11bb3b3c6b87397 Mon Sep 17 00:00:00 2001 From: m15a Date: Tue, 16 Apr 2024 11:39:58 +0000 Subject: [PATCH] docs(vim): auto generate help --- doc/srcerite.txt | 30 ++++++++++++------------------ 1 file changed, 12 insertions(+), 18 deletions(-) diff --git a/doc/srcerite.txt b/doc/srcerite.txt index 5053ad7..2030680 100644 --- a/doc/srcerite.txt +++ b/doc/srcerite.txt @@ -1,4 +1,4 @@ -*srcerite.txt* For NVIM v0.8.0 Last change: 2024 March 18 +*srcerite.txt* For NVIM v0.8.0 Last change: 2024 April 16 Maintainer: NACAMURA Mitsuhiro URL: https://github.com/m15a/nvim-srcerite @@ -8,7 +8,7 @@ License: BSD 3-Clause ============================================================================== 1. Description *srcerite-description* -`srcerite` is a colorscheme for Neovim, generated using nvim-highlite +`srcerite` is a Neovim colorscheme made with nvim-highlite , the Neovim colorscheme generator. It is heavily inspired by Srcery , long time my favorite Vim colorscheme. @@ -19,17 +19,11 @@ intended to make the best use of `srcery`’s contrasting color palette and ============================================================================== -2. Requirements *srcerite-requirements* +2. Installation *srcerite-installation* -- Neovim 0.8+ -- nvim-highlite - - -============================================================================== -3. Installation *srcerite-installation* - -Use any package manager. After installation, put the following line into your -`init.lua`. +Use any package manager. It requires nvim-highlite +. After installation, append the +following line to your `init.lua`. >lua vim.cmd.colorscheme 'srcerite' @@ -37,7 +31,7 @@ Use any package manager. After installation, put the following line into your ============================================================================== -4. Configuration *srcerite-configuration* +3. Configuration *srcerite-configuration* You can customize this colorscheme using the following global variables. @@ -59,8 +53,8 @@ OPTIONS *srcerite-configuration-options* SRCERITE_INVERSE_VISUAL ~ -Enable inverse highlighting (foreground and background colors replace with each -other) of visual selection (default: `true`). +Replace foreground and background colors with each other (i.e. inverse +highlighting) in visual selection (default: `true`). >lua vim.g.srcerite_inverse_vidual = false @@ -86,11 +80,11 @@ Enable inverse highlighting of matched parentheses (default: `false`). ============================================================================== -5. Contribution *srcerite-contribution* +4. Contributing *srcerite-contributing* If you like this colorscheme, don’t forget to add star to nvim-highlite -! Any contributions to this repo are -also welcome! +. Any contributions to this project +are also welcome. Generated by panvimdoc