https://github.com/4e554c4c/darkman.nvim

A neovim plugin for interfacing with the freedesktop dark mode standard
https://github.com/4e554c4c/darkman.nvim

neovim neovim-golang neovim-plugin night-mode theme-switcher

Last synced: 14 days ago
JSON representation

A neovim plugin for interfacing with the freedesktop dark mode standard

• Host: GitHub
• URL: https://github.com/4e554c4c/darkman.nvim
• Owner: 4e554c4c
• License: mit
• Created: 2023-01-24T04:20:49.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-08T17:23:48.000Z (about 1 year ago)
• Last Synced: 2024-07-31T20:49:31.446Z (3 months ago)
• Topics: neovim, neovim-golang, neovim-plugin, night-mode, theme-switcher
• Language: Go
• Homepage:
• Size: 12.7 KB
• Stars: 21
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-neovim - 4e554c4c/darkman.nvim - Follow the system dark-mode setting on Linux. (Colorscheme / Colorscheme Switchers)

README

        
# Darkman.nvim

**Darkman.nvim** is a neovim plugin written in Golang, designed to interface

with the Freedesktop Dark-mode standard. It is named after and integrates with

[darkman](https://darkman.whynothugo.nl/), a daemon which implements this

standard. However, the plugin should work on all compliant desktop environments

(including Gnome and KDE).

## Requirements

This plugin is currently in development, and no versions have been released.

Thus, to compile darkman.nvim a go compiler is required.

## Installation

Using [packer.nvim](https://github.com/wbthomason/packer.nvim)

```lua

use {

  '4e554c4c/darkman.nvim',

  run = 'go build -o bin/darkman.nvim',

  config = function()

    require 'darkman'.setup()

  end,

}

```

## Configuration

`setup` takes a dictionary of the following values (and defaults)

```lua

{

  change_background = true,

  send_user_event = false,

  colorscheme = nil, -- can be { dark = "x", light = "y" }

}

```

If `change_background` is true, `background` will be automatically set to

`light` or `dark`.

Please note that you can add extra functionality by listening to the `OptionSet

background` autocmd event.

If you would not like darkman.nvim to set `background`, you may set

`send_user_event=true`. In which case the `User DarkMode` or `User LightMode`

events will be triggered instead.

If the `colorscheme` option is set to a table with `dark` and `light` keys, the

colorschemes given will be set automatically.