|
| 1 | +*dracula.txt* For Vim version 8 Last change: 2018 March 27 |
| 2 | +*dracula* *vim-dracula* |
| 3 | + |
| 4 | + |\ ,, ~ |
| 5 | + \\ _ || _ ~ |
| 6 | + / \\ ,._-_ < \, _-_ \\ \\ || < \, ~ |
| 7 | + || || || /-|| || || || || /-|| ~ |
| 8 | + || || || (( || || || || || (( || ~ |
| 9 | + \\/ \\, \/\\ \\,/ \\/\\ \\ \/\\ ~ |
| 10 | + |
| 11 | + A dark theme for vim |
| 12 | + |
| 13 | +============================================================================== |
| 14 | +CONTENTS *dracula-contents* |
| 15 | + |
| 16 | + 1. Intro ................................................... |dracula-intro| |
| 17 | + 2. Usage ................................................... |dracula-usage| |
| 18 | + 3. Configuration ................................... |dracula-configuration| |
| 19 | + 4. Personal Customization .......................... |dracula-customization| |
| 20 | + 5. License ............................................... |dracula-license| |
| 21 | + 6. Bugs ..................................................... |dracula-bugs| |
| 22 | + 7. Contributing ..................................... |dracula-contributing| |
| 23 | + 8. Credits ............................................... |dracula-credits| |
| 24 | + |
| 25 | +============================================================================== |
| 26 | +INTRO *dracula-intro* |
| 27 | + |
| 28 | +Dracula is a vim plugin that contains |
| 29 | + |
| 30 | + - a dark colorscheme for vim |
| 31 | + - a similarly-themed colorscheme for the vim plugin airline |
| 32 | + (https://github.com/vim-airline/vim-airline) |
| 33 | + |
| 34 | +============================================================================== |
| 35 | +USAGE *dracula-usage* |
| 36 | + |
| 37 | +Install it with your favorite plugin manager, and then > |
| 38 | + colorscheme dracula |
| 39 | +in your vimrc ! |
| 40 | + |
| 41 | +If you are an airline user, you can also do > |
| 42 | + let g:airline_theme='dracula' |
| 43 | +to have airline use Dracula. |
| 44 | + |
| 45 | +============================================================================== |
| 46 | +CONFIGURATION *dracula-configuration* |
| 47 | + |
| 48 | +There are a couple of variables used by Dracula that you might want to adjust |
| 49 | +depending on your terminal's capabilities. |
| 50 | + |
| 51 | +Default values are shown. |
| 52 | + |
| 53 | +------------------------------------------------------------------------------ |
| 54 | +In the following section, `1` signifies `on` and `0` signifies `off`. |
| 55 | + |
| 56 | +* *g:dracula_bold* |
| 57 | +Include bold attributes in highlighting > |
| 58 | + let g:dracula_bold = 1 |
| 59 | +< |
| 60 | +* *g:dracula_italic* |
| 61 | +Include italic attributes in highlighting > |
| 62 | + let g:dracula_italic = 1 |
| 63 | +< |
| 64 | +* *g:dracula_underline* |
| 65 | +Include underline attributes in highlighting > |
| 66 | + let g:dracula_underline = 1 |
| 67 | +< |
| 68 | +* *g:dracula_undercurl* |
| 69 | +Include undercurl attributes in highlighting (only if underline enabled) > |
| 70 | + let g:dracula_undercurl = 1 |
| 71 | +< |
| 72 | +* *g:dracula_inverse* |
| 73 | +Include inverse attributes in highlighting > |
| 74 | + let g:dracula_inverse = 1 |
| 75 | +< |
| 76 | +============================================================================== |
| 77 | +CUSTOMIZATION *dracula-customization* |
| 78 | + |
| 79 | +Like all colorschemes, Dracula is easy to customize with |autocmd|. Make use |
| 80 | +of the |ColorScheme| event as in the following examples. |
| 81 | + |
| 82 | +It would be a good idea to put all of your personal changes in an |augroup|, |
| 83 | +which you can do with the following code: > |
| 84 | + augroup dracula_customization |
| 85 | + au! |
| 86 | + " autocmds... |
| 87 | + augroup END |
| 88 | +> |
| 89 | +
|
| 90 | +- To add underline styling to |hl-CursorLine|, you can use the following: > |
| 91 | + autocmd ColorScheme dracula hi CursorLine cterm=underline term=underline |
| 92 | +< |
| 93 | +============================================================================== |
| 94 | +LICENSE *dracula-license* |
| 95 | + |
| 96 | +MIT License. Copyright © 2016 Dracula Theme. |
| 97 | +Full text available at |
| 98 | +https://github.com/dracula/vim/blob/master/LICENSE |
| 99 | + |
| 100 | +============================================================================== |
| 101 | +BUGS *dracula-bugs* |
| 102 | + |
| 103 | +At the time of this writing, no major bugs have been found. |
| 104 | + |
| 105 | +If you find one and wish to report it, you can do so at |
| 106 | +https://github.com/dracula/vim/issues |
| 107 | + |
| 108 | +============================================================================== |
| 109 | +CONTRIBUTING *dracula-contributing* |
| 110 | + |
| 111 | +Want to submit a new feature, bugfix, or hack on Dracula? |
| 112 | +Submit pull requests to |
| 113 | +https://github.com/dracula/vim/pulls |
| 114 | + |
| 115 | +Existing code determines style guidelines. |
| 116 | + |
| 117 | +============================================================================== |
| 118 | +CREDITS *dracula-credits* |
| 119 | + |
| 120 | +Proudly built by the Dracula Theme organization |
| 121 | +https://github.com/dracula |
| 122 | + |
| 123 | +Dracula for other applications available at |
| 124 | +https://draculatheme.com |
| 125 | + |
| 126 | +Further information available at |
| 127 | +https://draculatheme.com/vim |
| 128 | + |
| 129 | +Maintained by: |
| 130 | +- Trevor Heins ( https://github.com/heinst ) |
| 131 | +- Blake Williams ( https://github.com/BlakeWilliams ) |
| 132 | +- Derek S. ( https://github.com/dsifford ) |
| 133 | + |
| 134 | +Git repository: |
| 135 | +https://github.com/dracula/vim |
| 136 | + |
| 137 | + vim:tw=78:ts=8:ft=help:norl: |
0 commit comments