night-owl.nvim

KO | EN

gitlite — search

#javascript #python #ruby #php #hacktoberfest #library #dotfiles #shell #c-plus-plus #bash #metadata #java

★ 352 Open GitHub ↗

🦉 🌌 Night Owl colorscheme implementation for Neovim with support for Treesitter and semantic tokens

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
 <h1>🦉 night-owl.nvim 🌌</h1>
 <a href="#contributors">
 <img src="https://img.shields.io/github/all-contributors/oxfist/night-owl.nvim?color=ee8449&style=flat-square" alt="All Contributors"></img>
 </a>
</div>
<div align="center">
 <picture>
 <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/oxfist/night-owl.nvim/main/img/light_logo.png" alt="Illustration of an owl">
 <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/oxfist/night-owl.nvim/main/img/dark_logo.png" alt="Illustration of an owl">
 <img src="img/light_logo.png" height="300" alt="Illustration of an owl" />
 </picture>
 <img src="img/calculator.png" alt="TypeScript code with Night Owl syntax highlighting on" style="border-radius:1em" />
</div>

The _best_ implementation of
[Sarah Drasner's Night Owl VSCode theme](https://github.com/sdras/night-owl-vscode-theme)
for Neovim with support for Tree-sitter and semantic tokens.

## 📦 Install In Zero Time

### packer.nvim

```lua
use("oxfist/night-owl.nvim")
```

### lazy.nvim

```lua
require("lazy").setup({
  "oxfist/night-owl.nvim",
  lazy = false, -- make sure we load this during startup if it is your main colorscheme
  priority = 1000, -- make sure to load this before all the other start plugins
  config = function()
    -- load the colorscheme here
    require("night-owl").setup()
    vim.cmd.colorscheme("night-owl")
  end,
})
```

### vim-plug

```vim
Plug 'oxfist/night-owl.nvim'
```

## 🚀 Start Using With A Single Line

> [!NOTE]
> You can skip this step if you followed the `lazy.nvim` setup, which
> already sets the colorscheme.

Add the following to your Lua configuration files, e.g.
`~/.config/nvim/init.lua` (your actual path might be different):

```lua
require("night-owl").setup()
vim.cmd.colorscheme("night-owl")
```

To enable `night-owl` for `lualine.nvim`, simply set the theme like this in your
settings 👇:

```lua
-- This Lualine config should be somewhere in your config files
require('lualine').setup {
  options = {
    -- ... other configs
    theme = 'night-owl'
    -- ... other configs
  }
}
```

## ⚙️ Configuration

The styling of the theme can be customized by calling `setup()`:

```lua
local night_owl = require("night-owl")

-- 👇 Add your own personal settings here
--@param options Config|nil
night_owl.setup({
    -- These are the default settings
    bold = true,
    italics = true,
    underline = true,
    undercurl = true,
    transparent_background = false,
})
```

## 🖥️ Requirements

TODO

## 🔎 Comparison

How does this port compare to the original VSCode theme? Check it out!

| Night Owl for VSCode | This Theme 🤩 |
| ---------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| <img src="./img/vscode.png" alt="Screenshot of VSCode theme" width="1062" /> | <img src="./img/neovim.png" alt="Screenshot of this theme" width="1078" /> |

## ✨ Why Should You Pick _This_ Version of Night Owl?

This implementation of Night Owl solves several syntax highlight issues and
discrepancies similar ports have when comparing to the original VSCode theme.

The following features allow making the programming experience as close to the
original VSCode theme as possible:

1. **Extended highlight groups**: through additional Treesitter queries. See
   [`after/queries`](./after/queries) for implementation details.
2. **Different background color when Neovim is inactive**: through autocommands.
   See [`after/plugin/autocmds.lua`](./after/plugin/autocmds.lua) for
   implementation details.

<details>
<summary>👇 Click to see comparison with <code>haishanh/night-owl.vim</code></summary>

With Treesitter installed you can see the overall look and feel is significantly
different:

- Different colors for several keywords like `let`, `const`, `async`,
 `function`, etc. Same happens for class names `EditFishForm` and `Sale`.
- Italics _not_ applied anywhere except for comments.
- Italics _incorrectly_ applied to JSDoc keywords `@param` and `@returns`.

| [haishanh/night-owl.vim](https://github.com/haishanh/night-owl.vim) | This Theme |
| ------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| <img src="./img/haishanh.png" alt="Screenshot of haishanh theme" width="900" /> | <img src="./img/neovim.png" alt="Screenshot of this theme" width="1014" /> |

</details>

### Language Support 🌐

> [!NOTE]
> I've personally optimized the colorscheme styling and robustness for these
> languages extensively enough to confidently say they look _acceptable_ to me.
> If you happen to build software with them, then I invite you to try out this
> theme! 🙂

**Coming Soon:**

- Lua ✅
- Vimscript ✅
- R ✅
- Python ✅
- Bash ✅
- TSX, Rust, Ruby, and many more!

## 🧩 Plugins Supported

- [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
- [nvim-tree](https://github.com/nvim-tree/nvim-tree.lua)
- [lualine.nvim](https://github.com/nvim-lualine/lualine.nvim)
- [indent-blankline.nvim](https://github.com/lukas-reineke/indent-blankline.nvim)
  `v2` and `v3`
- [toggleterm.nvim](https://github.com/akinsho/toggleterm.nvim)
- [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim)

## 🎇 Credits

- [Sarah Drasner](https://github.com/sdras) first and foremost, for creating
 such a beautiful and artistic color scheme that has made, for me personally,
 so much more _pleasurable_ the exhilirating act of building software.
- <https://www.monolisa.dev/> for one of the sweetest programming fonts out
 there.
- [Christian Chiarulli](https://github.com/ChristianChiarulli) for creating
 [`colorgen-nvim`](https://github.com/LunarVim/colorgen-nvim), an essential
 tool that helped me get started with this implementation.

## Code of Conduct

- [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md)

## License

- [`LICENSE`](./LICENSE)

## Contributors

<table>
 <tbody>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/oxfist"><img src="https://avatars.githubusercontent.com/u/934679?v=4?s=100" width="100px;" alt="Andrés Quilodrán"/> Andrés Quilodrán</a> <a href="#maintenance-oxfist" title="Maintenance">🚧</a> <a href="https://github.com/oxfist/night-owl.nvim/commits?author=oxfist" title="Code">💻</a> <a href="https://github.com/oxfist/night-owl.nvim/issues?q=author%3Aoxfist" title="Bug reports">🐛</a> <a href="https://github.com/oxfist/night-owl.nvim/commits?author=oxfist" title="Documentation">📖</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/dmnkgrc"><img src="https://avatars.githubusercontent.com/u/4812676?v=4?s=100" width="100px;" alt="Dominik Garcia"/> Dominik Garcia</a> <a href="https://github.com/oxfist/night-owl.nvim/issues?q=author%3Admnkgrc" title="Bug reports">🐛</a> <a href="https://github.com/oxfist/night-owl.nvim/commits?author=dmnkgrc" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/nanyaDev"><img src="https://avatars.githubusercontent.com/u/40901142?v=4?s=100" width="100px;" alt="Rish"/> Rish</a> <a href="https://github.com/oxfist/night-owl.nvim/issues?q=author%3AnanyaDev" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://www.lampeweb.de"><img src="https://avatars.githubusercontent.com/u/44268468?v=4?s=100" width="100px;" alt="Michael Lazarski"/> Michael Lazarski</a> <a href="https://github.com/oxfist/night-owl.nvim/issues?q=author%3Alampewebdev" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://denisw.de"><img src="https://avatars.githubusercontent.com/u/1032624?v=4?s=100" width="100px;" alt="Denis Washington"/> Denis Washington</a> <a href="https://github.com/oxfist/night-owl.nvim/issues?q=author%3Adenisw" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/kmlopez-hhl"><img src="https://avatars.githubusercontent.com/u/132054595?v=4?s=100" width="100px;" alt="kmlopez-hhl"/> kmlopez-hhl</a> <a href="https://github.com/oxfist/night-owl.nvim/issues?q=author%3Akmlopez-hhl" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/Benson9954029"><img src="https://avatars.githubusercontent.com/u/28132352?v=4?s=100" width="100px;" alt="Benson9954029"/> Benson9954029</a> <a href="https://github.com/oxfist/night-owl.nvim/commits?author=Benson9954029" title="Documentation">📖</a></td>
 </tr>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/gnoeyp"><img src="https://avatars.githubusercontent.com/u/62169778?v=4?s=100" width="100px;" alt="Silver Hong"/> Silver Hong</a> <a href="https://github.com/oxfist/night-owl.nvim/issues?q=author%3Agnoeyp" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/sebvilhelm"><img src="https://avatars.githubusercontent.com/u/25344971?v=4?s=100" width="100px;" alt="Sebastian Vilhelm Juhl"/> Sebastian Vilhelm Juhl</a> <a href="https://github.com/oxfist/night-owl.nvim/issues?q=author%3Asebvilhelm" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/jdsprink91"><img src="https://avatars.githubusercontent.com/u/19441026?v=4?s=100" width="100px;" alt="Jason Sprinkle"/> Jason Sprinkle</a> <a href="https://github.com/oxfist/night-owl.nvim/commits?author=jdsprink91" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/bendk"><img src="https://avatars.githubusercontent.com/u/1012809?v=4?s=100" width="100px;" alt="bendk"/> bendk</a> <a href="https://github.com/oxfist/night-owl.nvim/commits?author=bendk" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/gokayburuc"><img src="https://avatars.githubusercontent.com/u/20437751?v=4?s=100" width="100px;" alt="Gökay BÜRÜÇ"/> Gökay BÜRÜÇ</a> <a href="#ideas-gokayburuc" title="Ideas, Planning, & Feedback">🤔</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/aleetsaiya"><img src="https://avatars.githubusercontent.com/u/67775387?v=4?s=100" width="100px;" alt="Sean Tsai"/> Sean Tsai</a> <a href="https://github.com/oxfist/night-owl.nvim/commits?author=aleetsaiya" title="Documentation">📖</a> <a href="https://github.com/oxfist/night-owl.nvim/commits?author=aleetsaiya" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://georgiykuzora.ru/"><img src="https://avatars.githubusercontent.com/u/77954822?v=4?s=100" width="100px;" alt="Georgiy Kuzora"/> Georgiy Kuzora</a> <a href="https://github.com/oxfist/night-owl.nvim/commits?author=GeorgeKuzora" title="Code">💻</a></td>
 </tr>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/andrew-george"><img src="https://avatars.githubusercontent.com/u/95014217?v=4?s=100" width="100px;" alt="Andrew Berty"/> Andrew Berty</a> <a href="https://github.com/oxfist/night-owl.nvim/issues?q=author%3Aandrew-george" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/FStanDev"><img src="https://avatars.githubusercontent.com/u/116457798?v=4?s=100" width="100px;" alt="FStanDev"/> FStanDev</a> <a href="https://github.com/oxfist/night-owl.nvim/issues?q=author%3AFStanDev" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="http://rolandhaller.com"><img src="https://avatars.githubusercontent.com/u/88140523?v=4?s=100" width="100px;" alt="Roland Haller"/> Roland Haller</a> <a href="https://github.com/oxfist/night-owl.nvim/issues?q=author%3AProHaller" title="Bug reports">🐛</a> <a href="https://github.com/oxfist/night-owl.nvim/commits?author=ProHaller" title="Code">💻</a></td>
 </tr>
 </tbody>
</table>

night-owl.nvim

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README