Skip to content

Commit

Permalink
docs: update (neo)vim example
Browse files Browse the repository at this point in the history
Fixes #27
  • Loading branch information
Misterio77 committed Apr 21, 2023
1 parent e7e967c commit 493d113
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions lib/contrib/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,22 @@ rec {
# Takes a scheme, ouputs a vim theme package.
#
# The output theme name will be "nix-" followed by the coloscheme's slug, and
# should be set, for example, by adding to your vim config:
# "colorScheme nix-${config.colorScheme.slug}"
# should be set, for example, by adding "colorscheme nix-${config.colorScheme.slug}"
# to your vimrc.
#
# Example:
# programs.vim.plugins = [
# {
# plugin = vimThemeFromScheme { scheme = config.colorScheme; };
# config = "colorscheme ${config.colorScheme.slug}";
# }
# ];
# Vim example:
# programs.vim = {
# plugins = [
# (vimThemeFromScheme { scheme = config.colorScheme; })
# ];
# extraConfig = "colorscheme nix-${config.colorScheme.slug}";
# };
#
# Neovim example:
# programs.neovim.plugins = [{
# plugin = vimThemeFromScheme { scheme = config.colorScheme; };
# config = "colorscheme nix-${config.colorScheme.slug}";
# }];
vimThemeFromScheme = import ./vim-theme.nix { inherit pkgs; };

# Takes a scheme, ouputs a script that applies this scheme to the current shell.
Expand Down

0 comments on commit 493d113

Please sign in to comment.