{"id":13661784,"url":"https://github.com/pondrejk/vim-readability","last_synced_at":"2026-03-07T01:39:53.417Z","repository":{"id":83224996,"uuid":"43012669","full_name":"pondrejk/vim-readability","owner":"pondrejk","description":"A Vim plug-in that calculates the Flesch-Kincaid readability index per line.","archived":false,"fork":false,"pushed_at":"2020-08-17T08:14:11.000Z","size":33,"stargazers_count":11,"open_issues_count":2,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-02T05:13:23.287Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Vim script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pondrejk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2015-09-23T16:20:35.000Z","updated_at":"2021-12-05T08:27:40.000Z","dependencies_parsed_at":"2023-06-29T00:15:58.444Z","dependency_job_id":null,"html_url":"https://github.com/pondrejk/vim-readability","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pondrejk%2Fvim-readability","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pondrejk%2Fvim-readability/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pondrejk%2Fvim-readability/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pondrejk%2Fvim-readability/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pondrejk","download_url":"https://codeload.github.com/pondrejk/vim-readability/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223979817,"owners_count":17235471,"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":[],"created_at":"2024-08-02T05:01:41.569Z","updated_at":"2024-11-10T16:32:03.796Z","avatar_url":"https://github.com/pondrejk.png","language":"Vim script","funding_links":[],"categories":["Vim script"],"sub_categories":[],"readme":"vim-readability\n=================\n\nA Vim plug-in that calculates the [Flesch-Kincaid readability grade](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests) for every line in your document and displays the result in the sign column.\n\n## Dependencies\n\n### Ruby\nPlug-in requires the [odyssey](\u003chttps://github.com/cameronsutter/odyssey\u003e) ruby library for calculating the index.\n\n### Vim +ruby Feature Support\nVim requires that it is compiled with support for `+ruby` you can see if your vim supports it by running :version; \nOn Ubuntu it may require that you install `vim-gtk` and start it with `vim.gtk`\n\n## Installation\n\n* With [pathogen.vim](https://github.com/tpope/vim-pathogen):\n\n        cd ~/.vim/bundle\n        git clone git://github.com/pondrejk/vim-readability.git\n\n* With [Vundle](https://github.com/gmarik/vundle):\n\n        \" .vimrc\n        Bundle 'pondrejk/vim-readability'\n\n## Usage\n\nTo initialize the sign column:\n\n\u003e :ReadGradeOn\n\nTo turn it off:\n\n\u003e :ReadGradeOff\n\nThere is also the `:ReadGradeToggle` command you can map to a selected key in your .vimrc, for example:\n\n```Vim\nnmap \u003csilent\u003e \u003cF11\u003e :ReadGradeToggle\u003cCR\u003e\nimap \u003csilent\u003e \u003cF11\u003e \u003cESC\u003e:ReadGradeToggle\u003cCR\u003e\ncmap \u003csilent\u003e \u003cF11\u003e \u003cESC\u003e:ReadGradeToggle\u003cCR\u003e\n```\n\nTo automatically update the column on buffer save (disabled by default), put this into your .vimrc:\n\n```Vim\nlet g:readability_onsave = 0\n```\n\nTo customize colors used in GUI, set the following variables in your .vimrc (default values displayed here):\n\n```Vim\nlet g:read_guifg=\"#000000\"\nlet g:read_guibg_dumb=\"#41ae76\"\nlet g:read_guibg_easy=\"#238b45\"\nlet g:read_guibg_medium=\"#006d2c\"\nlet g:read_guibg_hard=\"#ff6666\"\nlet g:read_guibg_bloat=\"#ff0000\"\n```\n\nSimilarly for the console colors:\n\n```Vim\nlet g:read_ctermfg=\"Black\"\nlet g:read_ctermbg_dumb=\"LightGreen\"\nlet g:read_ctermbg_easy=\"Green\"\nlet g:read_ctermbg_medium=\"DarkGreen\"\nlet g:read_ctermbg_hard=\"LightMagenta\"\nlet g:read_ctermbg_bloat=\"Red\"\n```\n\nReadability column in action in GUI and CLI (sentences are from an [excellent essay](https://medium.com/@hughmcguire/why-can-t-we-read-anymore-503c38c131fe#.svxaye4p4) by Hugh McGuire):\n\n![](screenshots/example.png \"Readability collumn in action\")\n\nTo blacklist selected words from calculation, enable the following variable in your .vimrc:\n\n```Vim\nlet g:readability_blacklist_on = 1\n```\n\nBy default, plug-in searches for the blacklist at .vim/bundle/vim-readability/blacklist.txt\", you can change the path by setting the following variable in your .vimrc (default shown):\n\n```Vim\nlet g:readability_blacklist_path = \".vim/bundle/vim-readability/blacklist.txt\"\n```\n\n## Notes \u0026 known issues\n\n* readability metrics provided by odyssey are designed for English only\n* right now, there is just one sign column in Vim, so if you use git-gutter or similar plug-in, vim-readability will overwrite signs made by these plug-ins, sorry\n* If you receive the error message `E319: Sorry, the command is not available in this version:   ruby \u003c\u003c EOF` it is because you are not using a vim installation with support for `+ruby`, to resolve please see the [dependencies section](#vim-ruby-feature-support).\n\n## TODO\n\n* implement and other readability metrics provided by odyssey\n* be friends with markdown and asciidoc (odyssey does xml parsing by default)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpondrejk%2Fvim-readability","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpondrejk%2Fvim-readability","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpondrejk%2Fvim-readability/lists"}