{"id":13479809,"url":"https://github.com/preservim/vim-colors-pencil","last_synced_at":"2025-04-05T07:01:15.175Z","repository":{"id":12964927,"uuid":"15643358","full_name":"preservim/vim-colors-pencil","owner":"preservim","description":"Light (\u0026 dark) color scheme inspired by iA Writer","archived":false,"fork":false,"pushed_at":"2022-05-07T07:40:37.000Z","size":1075,"stargazers_count":610,"open_issues_count":5,"forks_count":72,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-03-29T06:00:54.081Z","etag":null,"topics":["prose","vim","vim-colorscheme","vim-plugin","writing"],"latest_commit_sha":null,"homepage":"","language":"Vim script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/preservim.png","metadata":{"files":{"readme":"README.markdown","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-01-05T01:25:17.000Z","updated_at":"2025-03-25T13:18:51.000Z","dependencies_parsed_at":"2022-09-18T23:11:54.319Z","dependency_job_id":null,"html_url":"https://github.com/preservim/vim-colors-pencil","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/preservim%2Fvim-colors-pencil","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/preservim%2Fvim-colors-pencil/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/preservim%2Fvim-colors-pencil/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/preservim%2Fvim-colors-pencil/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/preservim","download_url":"https://codeload.github.com/preservim/vim-colors-pencil/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247299828,"owners_count":20916190,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["prose","vim","vim-colorscheme","vim-plugin","writing"],"created_at":"2024-07-31T16:02:23.321Z","updated_at":"2025-04-05T07:01:15.020Z","avatar_url":"https://github.com/preservim.png","language":"Vim script","funding_links":[],"categories":["Vim Script","Vim script","colorschemes"],"sub_categories":[],"readme":"# vim-colors-pencil\n\n\u003e A light (and dark) color scheme for Vim inspired by iA Writer\n\n![markdown-example](http://i.imgur.com/BYLMdx5.jpg)\n\n## Features\n\nThe _pencil_ color scheme takes its inspiration from iA Writer, an elegant\nword processor available on the iOS and OSX platforms.\n\nThis Vim color scheme features:\n\n* Subtle indicators of changes in the gutter for [Signify][sig], [gitgutter][gg], etc.\n* Use for both code and prose, though it’s definitely geared towards the latter\n* Light and dark background variants\n* iTerm color scheme [available][it] for using this color scheme with terminal-based Vim\n* Support for [tpope/vim-markdown][tm], [preservim/vim-markdown][pm] (aka\n  plasticboy/vim-markdown), and [gabrielelana/vim-markdown][gm]\n* Support for the [bling/vim-airline][ba] status bar plugin\n* Support for Vim’s Conceal feature to hide `_` and `*` markup for\n  \\_*italic*\\_, \\*\\*__bold__\\*\\* and \\*\\*\\*___bold italic___\\*\\*\\* styled text in Markdown\n\n[tm]: https://github.com/tpope/vim-markdown\n[pm]: https://github.com/preservim/vim-markdown\n[ba]: https://github.com/bling/vim-airline\n[gm]: https://github.com/gabrielelana/vim-markdown\n\n## Requirements\n\nCurrently requires vim \u003e= 7.0\n\n## Installation\n\nFor a basic install simply copy the color scheme file to your\n`~/.vim/colors` directory.\n\nFor full support in which the airline theme is available, install using\nPathogen, Vundle, Neobundle, or your favorite Vim package manager. For\nmore recent versions of vim and neovim, use your pack directory. (See\n[:help packages][packages] for more information.)\n\n[packages]: https://vimhelp.org/repeat.txt.html#packages\n\n## Configuration\n\n### Contrast\n\nIf you’re looking for greater contrast, set the following global in your\n`.vimrc`:\n\n```vim\nlet g:pencil_higher_contrast_ui = 0   \" 0=low (def), 1=high\n```\n\nIt currently only affects the blacks and grays.\n\n### Headings color\n\nWhen using a filetype of markdown, the ‘#’ heading text is shaded dark\nblue by default. This compensates for the lack of a visual cue found in iA\nWriter where the heading indicators are inside the left margin.\n\nIf you’re looking for neutral heading colors:\n\n```vim\nlet g:pencil_neutral_headings = 1   \" 0=blue (def), 1=normal\n```\n\n### Code background color\n\nSimilar to the rendered markdown found on GitHub, `inline` and `fenced`\ncode blocks will have a subtle gray background.\n\nIf you’re looking for neutral code background:\n\n```vim\nlet g:pencil_neutral_code_bg = 1   \" 0=gray (def), 1=normal\n```\n\nSee `g:pencil_higher_contrast_ui` above for adjusting the code background\ncontrast.\n\n### Gutter Color\n\nFor users of [Signify][sig] or [gitgutter][gg], indicators will be subtle\nmonochrome by default. If you prefer colored indicators, set the following\nglobal:\n\n```vim\nlet g:pencil_gutter_color = 1      \" 0=mono (def), 1=color\n```\n\n[sig]: https://github.com/mhinz/vim-signify\n[gg]: https://github.com/airblade/vim-gitgutter\n\n### Curled Underline for Spelling Highlights\n\nYou can choose between `undercurl` and `underline` in highlighting\nmisspelled words.\n\n```vim\nlet g:pencil_spell_undercurl = 1       \" 0=underline, 1=undercurl (def)\n```\n\nNon-spell underlines remain non-curled.\n\n### Terminal Italics\n\nIf you're using Vim in the terminal and your terminal supports italics, you\ncan opt-in to italic support for some syntax highlighting, such as\ncomments, by setting the following global:\n\n```vim\nlet g:pencil_terminal_italics = 1\n```\n\n### Airline Theme\n\n![airline-example](http://i.imgur.com/V39pwZq.png)\n\nA matching theme for the [Airline][al] status bar plugin is available.\nEnable by adding to your `.vimrc`:\n\n```vim\nlet g:airline_theme = 'pencil'\n```\n\n[al]: https://github.com/bling/vim-airline\n\n### Concealing \\_\\_styling markup\\_\\_ in Markdown\n\nThe _pencil_ color scheme supports the highlighting groups in the\n[tpope/vim-markdown][tm] syntax plugin, to take advantage of Vim’s Conceal\nfeature to hide `_` and `*` markup for \\_*italic*\\_, \\*\\*__bold__\\*\\* and\n\\*\\*\\*___bold italic___\\*\\*\\* styled text in Markdown\n\nSee the [vim-pencil][pn] plugin for details on automatically enabling this\nfeature.\n\nFor more details on Vim’s Conceal feature, see:\n\n```vim\n:help conceallevel\n:help concealcursor\n```\n\n[tm]: https://github.com/tpope/vim-markdown\n\n## Usage\n\nJust like any other color scheme:\n\n```vim\n:colorscheme pencil\n```\n\nYou can toggle between the light and dark variants:\n\n```vim\n:set background=dark\n:set background=light\n```\n\nLike any other color scheme, you can add these commands to your `.vimrc`.\n\n## Font choices\n\niA Writer uses a typeface called ‘Nitti Light’ by Blue Monday. ($)\n\nFree alternatives with **bold** and _italic_ support include:\n\n* [Anonymous Pro](https://www.google.com/fonts/specimen/Anonymous+Pro) (serif)\n* [Courier Prime](http://quoteunquoteapps.com/courierprime/) (serif)\n* [Cousine](http://www.google.com/fonts/specimen/Cousine)\n* [DejaVu Sans Mono](http://dejavu-fonts.org/wiki/Download)\n* [Fantasque Sans Mono](http://openfontlibrary.org/en/font/fantasque-sans-mono)\n* [Liberation](https://fedorahosted.org/liberation-fonts/)\n* [Luxi Mono Regular](http://www.fontsquirrel.com/fonts/Luxi-Mono) (serif)\n* [Ubuntu Mono](https://www.google.com/fonts/specimen/Ubuntu+Mono)\n\nCousine is a good match for Nitti Light.\n\n## See also\n\n* [mattly/iterm-colors-pencil][it] - terminal support for mutt, tmux and iTerm\n* [gummesson/term-colors-pencil][tcp] - terminal support for urxvt and termite\n* [mattly/atom-colors-pencil-light][ap] - Atom version of the pencil color scheme\n* [nickburlett/vim-colors-stylus][vcs] - a fork, with a variation on pencil's colors\n\n[it]: https://github.com/mattly/iterm-colors-pencil\n[tcp]: https://github.com/gummesson/term-colors-pencil\n[ap]: https://github.com/mattly/atom-colors-pencil-light\n[vcs]: https://github.com/nickburlett/vim-colors-stylus\n\nIf you find this colorscheme useful, you may want to check out these\nplugins originally by [@reedes][re]:\n\n* [vim-lexical][lx] - building on Vim’s spell-check and thesaurus/dictionary completion\n* [vim-litecorrect][lc] - lightweight auto-correction for Vim\n* [vim-pencil][pn] - rethinking Vim as a tool for writers\n* [vim-textobj-quote][qu] - extends Vim to support typographic (‘curly’) quotes\n* [vim-textobj-sentence][ts] - improving on Vim's native sentence motion command\n* [vim-thematic][th] - modify Vim’s appearance to suit your task and environment\n* [vim-wheel][wh] - screen-anchored cursor movement for Vim\n* [vim-wordy][wo] - uncovering usage problems in writing\n* [vim-wordchipper][wc] - power tool for shredding text in Insert mode\n\n[re]: https://github.com/reedes\n[lx]: https://github.com/preservim/vim-lexical\n[lc]: https://github.com/preservim/vim-litecorrect\n[pn]: https://github.com/preservim/vim-pencil\n[ts]: https://github.com/preservim/vim-textobj-sentence\n[qu]: https://github.com/preservim/vim-textobj-quote\n[th]: https://github.com/preservim/vim-thematic\n[wh]: https://github.com/preservim/vim-wheel\n[wo]: https://github.com/preservim/vim-wordy\n[wc]: https://github.com/preservim/vim-wordchipper\n\nThe [README](https://github.com/preservim/vim-thematic) in\n_thematic_ has more details on setting up emulation of iA Writer.\n\n## Contributors\n\nThanks to those who have helped improve the _pencil_ color scheme:\n\n* [@mattly](https://github.com/mattly)\n* [@tamagokun](https://github.com/tamagokun)\n* [@gorodinskiy](https://github.com/gorodinskiy)\n\n## Future development\n\nIf you’ve spotted a problem or have an idea on improving this color\nscheme, please post it to the [GitHub project issue page][issues].\n\n[issues]: https://github.com/preservim/vim-colors-pencil/issues\n\n\u003c!-- vim: set tw=74 :--\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpreservim%2Fvim-colors-pencil","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpreservim%2Fvim-colors-pencil","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpreservim%2Fvim-colors-pencil/lists"}