https://github.com/pablopunk/vim-colors
Generate vim colors
https://github.com/pablopunk/vim-colors
Last synced: about 1 year ago
JSON representation
Generate vim colors
- Host: GitHub
- URL: https://github.com/pablopunk/vim-colors
- Owner: pablopunk
- Created: 2018-02-08T22:26:05.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-05-05T21:33:49.000Z (about 6 years ago)
- Last Synced: 2025-03-29T17:35:56.951Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://vimcolors.org
- Size: 142 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vim-colors
Returns vim color configuration for given inputs
> This is an npm package so you can use it in your Javascript projects. If you only want to generate a scheme, use [vimcolors.org](https://vimcolors.org)
## Install
```sh
npm install vim-colors
```
## Usage
This results into a `viml` configuration script with a dark background (black) and
a white foreground
```js
const vimColors = require('vim-colors')
const configString = vimColors('my-scheme', {
dark: true,
bg: '000000', // black
fg: 'ffffff', // white
menus: '002244', // navy blue
comments: 'cccccc', // gray
scheme: [
'4169e1',
'ff6347'
// You can add up to 6 colors
]
})
```
## Related
- [vimcolors.org](https://vimcolors.org): The website that uses this module
## License
MIT
## Author
|  |
| ---------------------------------------------------------------------------- |
| [Pablo Varela](https://pablo.life) |