Skip to content

Latest commit

 

History

History
125 lines (93 loc) · 4.04 KB

README.md

File metadata and controls

125 lines (93 loc) · 4.04 KB

doom-one.nvim

License Neovim version

FeaturesInstallScreenshotsContribute

Come join the dark side, we have cookies.

This colorscheme is ported from doom-emacs' doom-one.

IMPORTANT: This colorscheme requires Neovim >= 0.6.x to work!

Notices

  • 2022-08-08: doom-one is now using Neovim global variables for configurations again. It is using the same configuration options, see Install.
  • 2021-10-05: doom-one configurations are now defined in a setup function, see Install to know the valid setup options.
  • 2021-06-16: since the colorscheme is now 100% lua, your neovim must include this.

Features

  • Opt-in italic comments
  • Opt-in terminal colors
  • Opt-in TreeSitter support
  • Opt-in transparent background
  • Opt-in support for numerous plugins (nvim-tree, barbar, lspsaga, etc)
  • Opt-in First class support for Neorg

Install

Packer

use({
    'NTBBloodbath/doom-one.nvim',
    setup = function()
        -- Add color to cursor
		vim.g.doom_one_cursor_coloring = false
		-- Set :terminal colors
		vim.g.doom_one_terminal_colors = true
		-- Enable italic comments
		vim.g.doom_one_italic_comments = false
		-- Enable TS support
		vim.g.doom_one_enable_treesitter = true
		-- Color whole diagnostic text or only underline
        vim.g.doom_one_diagnostics_text_color = false
		-- Enable transparent background
		vim.g.doom_one_transparent_background = false

        -- Pumblend transparency
		vim.g.doom_one_pumblend_enable = false
		vim.g.doom_one_pumblend_transparency = 20

        -- Plugins integration
		vim.g.doom_one_plugin_neorg = true
		vim.g.doom_one_plugin_barbar = false
		vim.g.doom_one_plugin_telescope = false
		vim.g.doom_one_plugin_neogit = true
		vim.g.doom_one_plugin_nvim_tree = true
		vim.g.doom_one_plugin_dashboard = true
		vim.g.doom_one_plugin_startify = true
		vim.g.doom_one_plugin_whichkey = true
		vim.g.doom_one_plugin_indent_blankline = true
		vim.g.doom_one_plugin_vim_illuminate = true
		vim.g.doom_one_plugin_lspsaga = false
	end,
	config = function()
        vim.cmd("colorscheme doom-one")
    end,
})

Neorg support

If you want to get the best neorg look you will surely want to get headlines.nvim plugin.

doom-one already comes with sane defaults for headlines in Neorg buffers. However, you will need a custom configuration to get them working as expected:

require("headlines").setup({
    norg = {
        headline_highlights = {"Headline1", "Headline2", "Headline3", "Headline4", "Headline5", "Headline6"},
        codeblock_highlight = {"NeorgCodeBlock"},
    }
})
Neorg buffer with headlines plugin:

neorg headlines demo

Extras

Extra color configs for kitty can be found in extras. To use them, refer to their respective documentation.

Screenshots

Dark variant:

dark demo

Light variant:

light demo

Contribute

  1. Fork it (https://github.com/NTBBloodbath/doom-one.nvim/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

License

doom-one.nvim is MIT licensed.