Skip to content

Commit

Permalink
docs(vim): auto generate help
Browse files Browse the repository at this point in the history
  • Loading branch information
m15a authored and github-actions[bot] committed Apr 16, 2024
1 parent e604fe9 commit ee293e9
Showing 1 changed file with 12 additions and 18 deletions.
30 changes: 12 additions & 18 deletions doc/srcerite.txt
Original file line number Diff line number Diff line change
@@ -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 <m15@m15a.dev>
URL: https://github.com/m15a/nvim-srcerite
Expand All @@ -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
<https://github.com/Iron-E/nvim-highlite>, the Neovim colorscheme generator. It
is heavily inspired by Srcery <https://srcery.sh/>, long time my favorite Vim
colorscheme.
Expand All @@ -19,25 +19,19 @@ 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 <https://github.com/Iron-E/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
<https://github.com/Iron-E/nvim-highlite>. After installation, append the
following line to your `init.lua`.

>lua
vim.cmd.colorscheme 'srcerite'
<


==============================================================================
4. Configuration *srcerite-configuration*
3. Configuration *srcerite-configuration*

You can customize this colorscheme using the following global variables.

Expand All @@ -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
Expand All @@ -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
<https://github.com/Iron-E/nvim-highlite>! Any contributions to this repo are
also welcome!
<https://github.com/Iron-E/nvim-highlite>. Any contributions to this project
are also welcome.

Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

Expand Down

0 comments on commit ee293e9

Please sign in to comment.