Update some documentation

This commit is contained in:
Pedro Alves 2021-11-02 16:28:42 +00:00
parent 1cd9afd799
commit 79637ae41a
28 changed files with 347 additions and 63 deletions

View file

@ -0,0 +1,155 @@
# base16
Base16 is a set of colorschemes, so it comes with several themes you can choose from:
- 3024
- apathy
- ashes
- atelier-cave-light
- atelier-cave
- atelier-dune-light
- atelier-dune
- atelier-estuary-light
- atelier-estuary
- atelier-forest-light
- atelier-forest
- atelier-heath-light
- atelier-heath
- atelier-lakeside-light
- atelier-lakeside
- atelier-plateau-light
- atelier-plateau
- atelier-savanna-light
- atelier-savanna
- atelier-seaside-light
- atelier-seaside
- atelier-sulphurpool-light
- atelier-sulphurpool
- atlas
- bespin
- black-metal-bathory
- black-metal-burzum
- black-metal-dark-funeral
- black-metal-gorgoroth
- black-metal-immortal
- black-metal-khold
- black-metal-marduk
- black-metal-mayhem
- black-metal-nile
- black-metal-venom
- black-metal
- brewer
- bright
- brogrammer
- brushtrees-dark
- brushtrees
- chalk
- circus
- classic-dark
- classic-light
- codeschool
- cupcake
- cupertino
- darktooth
- default-dark
- default-light
- dracula
- eighties
- embers
- flat
- fruit-soda
- github
- google-dark
- google-light
- grayscale-dark
- grayscale-light
- greenscreen
- gruvbox-dark-hard
- gruvbox-dark-medium
- gruvbox-dark-pale
- gruvbox-dark-soft
- gruvbox-light-hard
- gruvbox-light-medium
- gruvbox-light-soft
- harmonic-dark
- harmonic-light
- heetch-light
- heetch
- helios
- hopscotch
- horizon-dark
- ia-dark
- ia-light
- icy
- irblack
- isotope
- macintosh
- marrakesh
- material-darker
- material-lighter
- material-palenight
- material
- material-vivid
- materia
- mellow-purple
- mexico-light
- mocha
- monokai
- nord
- oceanicnext
- ocean
- onedark
- one-light
- outrun-dark
- papercolor-dark
- papercolor-light
- paraiso
- phd
- pico
- pop
- porple
- railscasts
- rebecca
- seti
- shapeshifter
- snazzy
- solarflare
- solarized-dark
- solarized-light
- spacemacs
- summerfruit-dark
- summerfruit-light
- synth-midnight-dark
- tomorrow-night-eighties
- tomorrow-night
- tomorrow
- tube
- twilight
- unikitty-dark
- unikitty-light
- woodland
- xcode-dusk
- zenburn
More information can be found on the official base16 website, [here](http://chriskempson.com/projects/base16/).
## Options
### `colorschemes.base16.enable`
**Description**: Enables base16
**Type**: `bool`
### `colorschemes.base16.useTruecolor`
**Description**: Whether to use truecolor for the colorschemes. If set to
false, you'll need to set up base16 in your shell.
**Type**: `bool`
**Default**: `true`
### `colorschemes.base16.setUpBar`
**Description**: Whether to install the matching plugin for your statusbar. This does nothing as of yet, waiting for upstream support.
**Type**: `bool`
**Default**: `true`

View file

@ -0,0 +1,144 @@
# gruvbox
This plugin sets up the `gruvbox` colorscheme.
## Options
### `colorschemes.gruvbox.enable`
**Description**: Enable gruvbox
**Type**: `bool`
### `colorschemes.gruvbox.italics`
**Description**: Enable italics
**Type**: `bool`
### `colorschemes.gruvbox.bold`
**Description**: Enable bold
**Type**: `bool`
### `colorschemes.gruvbox.underline`
**Description**: Enable underlined text
**Type**: `bool`
### `colorschemes.gruvbox.undercurl`
**Description**: Enable undercurled text
**Type**: `bool`
### `colorschemes.gruvbox.contrastDark`
**Description**: Contrast for the dark mode
**Type**: `nullOr (enum [ "soft" "medium" "hard" ])`
**Default**: `null`
### `colorschemes.gruvbox.contrastLight`
**Type**: `nullOr (enum [ "soft" "medium" "hard" ])`
**Default**: `null`
**Description**: "Contrast for the light mode";
### `colorschemes.gruvbox.highlightSearchCursor`
**Type**: `nullOr colors`
**Default**: `null`
**Description**: "The cursor background while search is highlighted";
### `colorschemes.gruvbox.numberColumn`
**Description**: The number column background
**Type**: `nullOr colors`
**Default**: `null`
### `colorschemes.gruvbox.signColumn`
**Description**: "The sign column background";
**Type**: `nullOr colors`
**Default**: `null`
### `colorschemes.gruvbox.colorColumn`
**Description**: "The color column background";
**Type**: `nullOr colors`
**Default**: `null`
### `colorschemes.gruvbox.vertSplitColor`
**Description**: "The vertical split background color";
**Type**: `nullOr colors`
**Default**: `null`
### `colorschemes.gruvbox.italicizeComments`
**Description**: "Italicize comments";
**Type**: `bool`
**Default**: `true`
### `colorschemes.gruvbox.italicizeStrings`
**Description**: "Italicize strings";
**Type**: `bool`
**Default**: `false`
### `colorschemes.gruvbox.invertSelection`
**Description**: "Invert the select text";
**Type**: `bool`
**Default**: `true`
### `colorschemes.gruvbox.invertSigns`
**Description**: "Invert GitGutter and Syntastic signs";
**Type**: `bool`
**Default**: `false`
### `colorschemes.gruvbox.invertIndentGuides`
**Description**: "Invert indent guides";
**Type**: `bool`
**Default**: `false`
### `colorschemes.gruvbox.invertTabline`
**Description**: "Invert tabline highlights";
**Type**: `bool`
**Default**: `false`
### `colorschemes.gruvbox.improvedStrings`
**Description**: "Improved strings";
**Type**: `bool`
**Default**: `false`
### `colorschemes.gruvbox.improvedWarnings`
**Description**: "Improved warnings";
**Type**: `bool`
**Default**: `false`
### `colorschemes.gruvbox.transparentBg`
**Description**: Transparent background
**Type**: `bool`
### `colorschemes.gruvbox.trueColor`
**Description**: Enable true color support
**Type**: `bool`

View file

@ -0,0 +1,6 @@
# vim-one
## Options
### `colorschemes.one.enable`
**Description**: Enable vim-one
**Type**: `bool`

View file

@ -0,0 +1,6 @@
# onedark
## Options
### `colorschemes.onedark.enable`
**Description**: Enable onedark
**Type**: `bool`

View file

View file

View file

View file

View file

View file

View file

View file

View file

View file

View file

View file

View file

View file

View file

View file

View file

View file

View file

View file

View file

View file

97
flake.lock generated
View file

@ -3,11 +3,11 @@
"flake-compat": {
"flake": false,
"locked": {
"lastModified": 1606424373,
"narHash": "sha256-oq8d4//CJOrVj+EcOaSXvMebvuTkmBJuT5tzlfewUnQ=",
"lastModified": 1627913399,
"narHash": "sha256-hY8g6H2KFL8ownSiFeMOjwPC8P0ueXpCVEbxgda3pko=",
"owner": "edolstra",
"repo": "flake-compat",
"rev": "99f1c2157fba4bfe6211a321fd0ee43199025dbf",
"rev": "12c64ca55c1014cdc1b16ed5a804aa8576601ff2",
"type": "github"
},
"original": {
@ -18,11 +18,11 @@
},
"flake-utils": {
"locked": {
"lastModified": 1614513358,
"narHash": "sha256-LakhOx3S1dRjnh0b5Dg3mbZyH0ToC9I8Y2wKSkBaTzU=",
"lastModified": 1629481132,
"narHash": "sha256-JHgasjPR0/J1J3DRm4KxM4zTyAj4IOJY8vIl75v/kPI=",
"owner": "numtide",
"repo": "flake-utils",
"rev": "5466c5bbece17adaab2d82fae80b46e807611bf3",
"rev": "997f7efcb746a9c140ce1f13c72263189225f482",
"type": "github"
},
"original": {
@ -31,37 +31,42 @@
"type": "github"
}
},
"gitignore": {
"flake": false,
"neovim-flake": {
"inputs": {
"flake-utils": "flake-utils",
"nixpkgs": [
"neovim-nightly",
"nixpkgs"
]
},
"locked": {
"lastModified": 1611672876,
"narHash": "sha256-qHu3uZ/o9jBHiA3MEKHJ06k7w4heOhA+4HCSIvflRxo=",
"owner": "hercules-ci",
"repo": "gitignore.nix",
"rev": "211907489e9f198594c0eb0ca9256a1949c9d412",
"dir": "contrib",
"lastModified": 1635807019,
"narHash": "sha256-jhp7vrTDooX2DUKvUKfCnrV0fyVk8sFkgljnPN/Iu+Q=",
"owner": "neovim",
"repo": "neovim",
"rev": "29cec32f44db358b0dfcd560d2ba8228b9d9de39",
"type": "github"
},
"original": {
"owner": "hercules-ci",
"repo": "gitignore.nix",
"dir": "contrib",
"owner": "neovim",
"repo": "neovim",
"type": "github"
}
},
"neovim-nightly": {
"inputs": {
"flake-compat": "flake-compat",
"flake-utils": "flake-utils",
"gitignore": "gitignore",
"neovim-nightly": "neovim-nightly_2",
"nixpkgs": "nixpkgs",
"pre-commit-hooks": "pre-commit-hooks"
"neovim-flake": "neovim-flake",
"nixpkgs": "nixpkgs"
},
"locked": {
"lastModified": 1616055137,
"narHash": "sha256-pEVSPu8MnqAj4xHYPZ/oKcwFkPqFKm2fMDv1nw8YA8E=",
"lastModified": 1635840832,
"narHash": "sha256-saUqVPGI7V/d7T7AK6PRzkS1M5T3aSu39nFLaX08NZA=",
"owner": "nix-community",
"repo": "neovim-nightly-overlay",
"rev": "b247024d70256660111942e6c51e6486487edc14",
"rev": "54a736a2c9606cef8895d555c2b080eb78f691b6",
"type": "github"
},
"original": {
@ -70,45 +75,29 @@
"type": "github"
}
},
"neovim-nightly_2": {
"flake": false,
"locked": {
"lastModified": 1615916681,
"narHash": "sha256-o9CsM9VACCk1RiRimYZtqwxatth4t9EqzFQMMFjaUR4=",
"owner": "neovim",
"repo": "neovim",
"rev": "0ab88c2ea80caa7cda97b3a8479d0d32e4636ab6",
"type": "github"
},
"original": {
"owner": "neovim",
"repo": "neovim",
"type": "github"
}
},
"nixpkgs": {
"locked": {
"lastModified": 1615991631,
"narHash": "sha256-TEDPXYy9sVLyctW/OBqxhxlxPmvTwRqXBch0eexJm8Y=",
"lastModified": 1635792138,
"narHash": "sha256-D79GqaYrwgyM4wvOPbQeKveAHROnVh97F36iSGZO9uA=",
"owner": "nixos",
"repo": "nixpkgs",
"rev": "f137bcd5c92906ae0f924769a95b8c8e6602f90b",
"rev": "b165ce0c4efbb74246714b5c66b6bcdce8cde175",
"type": "github"
},
"original": {
"owner": "nixos",
"ref": "nixpkgs-unstable",
"ref": "nixos-unstable",
"repo": "nixpkgs",
"type": "github"
}
},
"nixpkgs_2": {
"locked": {
"lastModified": 1615888535,
"narHash": "sha256-wR49KkuahcNq1xU3Tk+Mfbob3g2/B/fpbWPw8X+1wsg=",
"lastModified": 1635792138,
"narHash": "sha256-D79GqaYrwgyM4wvOPbQeKveAHROnVh97F36iSGZO9uA=",
"owner": "NixOS",
"repo": "nixpkgs",
"rev": "1f77a4c8c74bbe896053994836790aa9bf6dc5ba",
"rev": "b165ce0c4efbb74246714b5c66b6bcdce8cde175",
"type": "github"
},
"original": {
@ -118,22 +107,6 @@
"type": "github"
}
},
"pre-commit-hooks": {
"flake": false,
"locked": {
"lastModified": 1609781048,
"narHash": "sha256-RTu4NDdAgwv83aFFJDnUkQFl/7giDSeEtQ/N17xxiXY=",
"owner": "cachix",
"repo": "pre-commit-hooks.nix",
"rev": "c7e3896e35ceea480a7484ec1709be7bdda8849d",
"type": "github"
},
"original": {
"owner": "cachix",
"repo": "pre-commit-hooks.nix",
"type": "github"
}
},
"root": {
"inputs": {
"neovim-nightly": "neovim-nightly",

View file

@ -25,7 +25,7 @@ in
config = let
extensionPlugins = with cfg.extensions; with pkgs.vimPlugins;
(optional frecency.enable telescope-frecency-nvim) ++
(optional frecency.enable sql-nvim);
(optional frecency.enable sqlite-lua);
extensionPackages = with cfg.extensions; with pkgs;
(optional frecency.enable sqlite);