{"id":15445204,"url":"https://github.com/rmariano/vim-config","last_synced_at":"2025-04-19T20:38:06.783Z","repository":{"id":12045954,"uuid":"14631720","full_name":"rmariano/vim-config","owner":"rmariano","description":"Vim configuration","archived":false,"fork":false,"pushed_at":"2024-12-12T09:45:47.000Z","size":158,"stargazers_count":12,"open_issues_count":0,"forks_count":2,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-29T13:06:32.692Z","etag":null,"topics":["colour-schemes","editor","linux","vim","vim-configuration","viml"],"latest_commit_sha":null,"homepage":"http://rmariano.github.io/vim-config","language":"Vim Script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rmariano.png","metadata":{"files":{"readme":"README.rst","changelog":"changelog.rst","contributing":".github/CONTRIBUTING","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-11-22T23:00:58.000Z","updated_at":"2024-12-12T09:45:51.000Z","dependencies_parsed_at":"2022-09-11T09:40:38.475Z","dependency_job_id":null,"html_url":"https://github.com/rmariano/vim-config","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariano%2Fvim-config","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariano%2Fvim-config/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariano%2Fvim-config/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariano%2Fvim-config/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rmariano","download_url":"https://codeload.github.com/rmariano/vim-config/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249795193,"owners_count":21326776,"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":["colour-schemes","editor","linux","vim","vim-configuration","viml"],"created_at":"2024-10-01T19:44:17.999Z","updated_at":"2025-04-19T20:38:06.760Z","avatar_url":"https://github.com/rmariano.png","language":"Vim Script","funding_links":[],"categories":[],"sub_categories":[],"readme":"Vim Configuration\n=================\n\n.. image:: https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square\n   :target: LICENSE\n   :alt: MIT license\n\nThis is an ongoing project of that sets up\na particular configuration for improved productivity.\n\nThe goal is to develop a good configuration for the Vim editor, tailored\nfor Python development.\n\nIt does not change the behavior of VIM, since this configuration only\nadds comfortable shortcuts, and settings that are recommended for\nsoftware development (coding good practices).\n\n\n.. contents ::\n\n\nInstallation\n------------\n\nInstant\n^^^^^^^\n\nCopy and paste the following command in your terminal:\n\n.. code:: bash\n\n    mkdir -p ~/.vim \u0026\u0026 wget -O ~/.vim/Makefile -N https://raw.github.com/rmariano/vim-config/master/Makefile \u0026\u0026 make -C ~/.vim install\n\n\nAutomatic\n^^^^^^^^^\n\nUse the included `Makefile \u003cMakefile\u003e`_ script which downloads and replaces the\nfiles on their latest versions. Bear in mind that requires ``wget`` and\n``Makefile`` which comes installed in most of the distributions.\n\n.. code:: bash\n\n    make install\n\nOr, if you want to install a particular version (tag or branch).\n\n.. code:: bash\n\n    make install BRANCH=\u003ctag_or_branch\u003e\n\nNote: this is supported from version ``\u003e=v0.4``.\n\nThe previous methods rely on getting the files from the Internet, but\nalternatively, if you have already downloaded the project, and unpacked it\nsomewhere in your file system, you can install it by running:\n\n.. code:: bash\n\n    make deploy\n\nThat will copy the files to their respective locations. Note that this will\nreplace any previous instances of those file you might have had there. If you\nwant to start over, you could simply run ``make clean``, which will remove the\nfiles for this project (not the extra packages, though).\n\n\nFeatures\n--------\nThe leader key (``\u003cleader\u003e``) can be customized, but it's mapped to ``-`` by\ndefault.\n\n* ``\u003cleader\u003e`` + ``j``: Toggle the margin at the column number set by ``textwidth``.\n\n* ``\u003cleader\u003e`` + ``tw`` will highlight trailing white spaces.\n\n* ``\u003cleader\u003e`` + ``w`` will remove them (they'll also be automatically removed\n  when saving :-)\n\n* ``autoindent`` \u0026 ``smartindent``.\n\n* ``\u003cleader\u003e`` + ``c`` Will *comment* out lines of code, and\n  ``\u003cleader\u003e`` + ``u`` will *uncomment* them out. Both apply to normal and visual modes.\n\n* Function keys\n\n  * ``\u003cF2\u003e``: toggle spell check.\n  * ``\u003cF3\u003e``: Correct files automatically\n\n    * XML: auto-format \u0026 indent.\n    * Python: PEP-8, sort imports, format with black, and run ``flake8`` checks.\n\n  * ``\u003cF4\u003e``: toggle paste mode.\n\n  * ``\u003cF7\u003e``: Run checks in the file (currently only Python is supported).\n\n* ``\u003cleader\u003e`` +  ``nh`` as a shortcut for ``:nohlsearch`` (No highlight).\n\n* A color scheme I like.\n\n* Customizations for certain file types: Python, YAML, XML, and more to come over time.\n\n* A status line with useful information (file name with path, modification\n  flag, file type, column, lines, and position (in %).\n\n* ``;t`` available for searching development tags, such as ``TODO`` or\n  ``FIXME``, rendering the results in a quick fix window. Warning: searches\n  recursively.\n\n* ``\u003cleader\u003e`` + ``n``, ``\u003cleader\u003e`` + ``p`` for moving to the *next* and\n  *previous* entries in the quick-fix window, respectively. ``\u003cleader\u003e`` + ``q``\n  for closing it.\n\n* ``\u003cleader\u003e`` + ``e`` to toggle line numbers (enabled by default).\n\n* Can save files with ``sudo`` that were opened with less permissions: ``:w!!``\n  to ``sudo`` save the file.\n\n* Mappings for managing tabs\n\n  * ``\u003cleader\u003e`` + ``tn``:  **T**\\ab **N**\\ew, opens a new tab to the right.\n  * ``\u003cleader\u003e`` + ``to``:  **T**\\ab **O**\\nly, close all tabs but the current one.\n  * ``\u003cleader\u003e`` + ``tc``:  **T**\\ab **C**\\lose, close current tab.\n  * ``\u003cleader\u003e`` + ``tm``:  **T**\\ab **M**\\ove, current to the end.\n\n* Window splits properly configured\n\n  * New vertical splits, to the right\n\n  * ``\u003cC-j\u003e``: for moving between splits (instead of ``\u003cC-W\u003e\u003cC-j\u003e``).\n    Same for ``h``, ``k``, or ``l`` respectively.\n\n* `Ctrl` + `C`: Copy selected content to clipboard.\n\n* Other features\n\n  * ``scrolloff=10``: offset of 10 lines when scrolling\n  * Performance improvements\n  * Silent bells\n  * Set hidden buffers\n\nColor scheme\n------------\n\nThe color scheme requires the terminal to support 256 colors. Most of the\nterminals already support this, but some terminal multiplexers like ``tmux``\nmight require to be run as: ``tmux -2`` in order to support this.\n\nIn addition, just the command-line classic Vim version is supported, so no\nsupport for ``Gvim`` or graphical versions is included for the color scheme,\nalthough pull requests are welcomed.\n\nCaptures\n^^^^^^^^\n\nHere are some examples of how the color scheme looks like.\n\n.. image:: https://rmariano.github.io/itarch/vim-capture1.png\n   :target: https://rmariano.github.io/itarch/vim-capture1.png\n   :width: 883px\n   :height: 391px\n   :alt: Vim capture 1\n   :align: center\n\nPlease note this might depend on the configuration of your terminal as well.\n\n.. image:: https://rmariano.github.io/itarch/vim-capture2.png\n   :target: https://rmariano.github.io/itarch/vim-capture2.png\n   :width: 574px\n   :height: 596px\n   :alt: Vim capture 2\n   :align: center\n\n\nContributing\n------------\n\nIf you want to try the project, and tweak the settings, I would recommend you\nto clone the repository, and use the development deployment, which creates\nsymlinks of the files in this project, like:\n\n.. code:: bash\n\n    make dev-deploy\n\nIn addition, take a moment to read the contributing guidelines.\n\nDependencies\n------------\n\n* Vim 8+\n* Linux, OSX (Other platforms are supported on a best-effort basis).\n\n\nExternal plug-ins\n^^^^^^^^^^^^^^^^^\n\nI prefer to keep the ``.vimrc`` configuration as simple as possible, so this\nproject is a collection of settings, configurations, and helpers. That\nmaintains the Vim installation as general as possible.\n\nHowever, on a daily basis, we might want some extra, few plug-ins.\n\nThese are `flake8 \u003chttps://github.com/nvie/vim-flake8\u003e`_,\n`fugitive vim \u003chttps://github.com/tpope/vim-fugitive\u003e`_, and\n`NERDTree \u003chttps://github.com/scrooloose/nerdtree\u003e`_.\n\n**Please note**: The installation of the extra dependencies requires ``Vim\n8.0`` or newer, since it install the external projects as packages.\n\nThey can be installed with:\n\n.. code:: bash\n\n    make extras\n\n\nEnjoy!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frmariano%2Fvim-config","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frmariano%2Fvim-config","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frmariano%2Fvim-config/lists"}