update readme.md

This commit is contained in:
Max Miliano 2023-03-27 19:05:01 -03:00
parent a61c484c59
commit ce21136034
4 changed files with 80 additions and 14 deletions

View file

@ -1,4 +1,13 @@
#### CONTRIBUTING TO DRACULA
To contribute to Dracula.nvim colorscheme, follow these instructions for using [colorgen-nvim](https://github.com/ChristianChiarulli/colorgen-nvim).
Please be careful not to modify the init.lua and autocmd files. The only folders you need to look at are palettes and themes.
1. Fork the `dracula.nvim` repository by clicking the `Fork` button on github.
2. Create a new branch for your contribution:
git checkout -b feat-plugin-support
3. Make your changes using [colorgen-nvim](https://github.com/ChristianChiarulli/colorgen-nvim)
4. Push your changes to your fork
5. Submit a pull request
6. Wait for feedback from the maintainers.
Thank you for contributing to `dracula.nvim`

27
CUSTOMIZE.md Normal file
View file

@ -0,0 +1,27 @@
#### How to customize a colorscheme
To override a highlight group, you will need to use the vim.api.nvim_set_hl()
function.
This function allows you to set the colors for a specific highlight group.
Here's an example of how to use this function to set the color of the
CursorLineNr highlight group to yellow:
local colors = require('dracula.palettes')
-- local colors = require('dracula.palettes.soft')
vim.api.nvim_set_hl(0, 'CursorLineNr', { fg = colors.yellow })
In this example, we first load the dracula color palette into the colors variable. Then, we use vim.api.nvim_set_hl()
to set the color of the CursorLineNr highlight group to the value of colors.yellow.
#### How to find a Highlight group
To find a highlight group that you want to customize, you can use the `:Inspect command`.
This command shows the current highlight
groups being applied to the code in the current buffer. Here's how to use it:
Alternatively, you can use plugins like [Telescope](https://github.com/nvim-telescope/telescope.nvim) or
[Playground](https://github.com/nvim-treesitter/playground) to find the highlight groups you need to customize your colorscheme.
For example, you can use the `:Telescope highlights` command with the Telescope
plugin to list all the available highlight
groups and select the one you want to customize.

View file

@ -6,7 +6,7 @@ To install dracula you need a plugin manager.
A plugin manager is a tool that helps users install and manage plugins.
Below is a list of some plugin managers that you could install.
- [lazy.nvim](folke/lazy.nvim) *recommended*
- [lazy.nvim](folke/lazy.nvim) _recommended_
- [packer.nvim](wbthomason/packer.nvim)
- [vim-plug](https://github.com/junegunn/vim-plug)
@ -14,7 +14,8 @@ Below is a list of some plugin managers that you could install.
Here's an example of how to install dracula using the [lazy.nvim](https://github.com/folke/lazy.nvim) plugin manager:
require('lazy').setup({
```lua
require('lazy').setup({
{
'dracula/nvim',
lazy = false, -- make sure we load this during startup if it is your main colorscheme
@ -23,16 +24,38 @@ Here's an example of how to install dracula using the [lazy.nvim](https://github
local dracula = require('dracula')
dracula.setup({})
-- dracula.setup({ soft = false, transparent = false }) available options
vim.cmd('colorscheme dracula')
end
},
})
```
#### Configuration
The dracula.nvim theme can be configured using the following options:
`soft`
- Type: boolean
- Default: false
Set this option to true to enable the soft version of the Dracula color palette, which has reduced color saturation.
Set it to false to use the original, more vibrant colors.
`transparent`
- Type: boolean
- Default: false
```lua
require('dracula').setup({
soft = false,
transparent = false
})
```
Lazy will install Dracula colorscheme in the following directories:
DATA DIRECTORY (DEFAULT)
DATA DIRECTORY (DEFAULT)
*$XDG_DATA_HOME* Nvim: stdpath("data")
Unix: ~/.local/share ~/.local/share/nvim/lazy
Windows: ~/AppData/Local ~/AppData/Local/nvim-data/lazy

View file

@ -1,6 +1,6 @@
# Dracula for [Neovim](https://neovim.io)
> A dark theme for [Neovim](https://neovim.io).
> Created with [colorgen](https://github.com/ChristianChiarulli/colorgen-nvim)
![Screenshot](https://user-images.githubusercontent.com/50273941/227779719-6e003e4a-f8e8-40bc-8a9f-ebfd7ea13fe6.png)
@ -8,18 +8,25 @@
All instructions can be found at [INSTALL.md](https://github.com/maxmx03/dracula.nvim/blob/master/INSTALL.md).
## Team
## How to customize
This theme is maintained by the following person(s) and a bunch of [awesome contributors](https://github.com/dracula/neovim/graphs/contributors).
All instructions can be found at [CUSTOMIZE.md](https://github.com/maxmx03/dracula.nvim/blob/master/INSTALL.md).
## Constributions
All instructions can be found at [CONTRIBUTING.md](https://github.com/maxmx03/dracula.nvim/blob/master/CONTRIBUTING.md)
## Maintainers
| [![Max](https://github.com/maxmx03.png?size=100)](https://github.com/maxmx03) |
| ---------------------------------------------------------------------------------------- |
| ----------------------------------------------------------------------------- |
| Max Miliano |
## Community
## Designed by
- [Twitter](https://twitter.com/draculatheme) - Best for getting updates about themes and new stuff.
- [GitHub](https://github.com/dracula/dracula-theme/discussions) - Best for asking questions and discussing issues.
- [Discord](https://draculatheme.com/discord-invite) - Best for hanging out with the community.
[![Zeno Rocha](https://github.com/zenorocha.png?size=100)](https://github.com/zenorocha)
Zeno Rocha: [learn more](https://draculatheme.com/about)
## License