chawley/dotfiles-vim
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
Charles Hawley
2025-04-14 09:17:33 -04:00
parent 48dd07630c
commit 41a036f3ec
1 changed files with 29 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@@ -1,45 +1,41 @@
# README - dotfiles-vim
---
filecreated:
fileupdated: 2025-04-14
filetags: [readme]
---
- Created :
- Updated : 2024-02-27 14:19
# dotfiles-vim
I want to finally have a `.vimrc` in which I understand each and every line. After years of collecting snips and
scraps from other people's dotfiles, I want to make sure that I am aware of what my `.vimrc` is doing.
I want to finally have a `.vimrc` in which I understand each and every line. After years of collecting snips and scraps from other people's dotfiles, I want to make sure that I am aware of what my `.vimrc` is doing.
This configuration is based heavily on the guide I found here: [Vim Zero](https://www.oliversherouse.com/posts/vim_zero.html)
which does exactly what I am aiming to do here: wipe the slate clean and start over.
This configuration is based heavily on the guide I found here: [Vim Zero](https://www.oliversherouse.com/posts/vim_zero.html) which does exactly what I am aiming to do here: wipe the slate clean and start over.
Whenever possible, I've noted the URL from which I found the setting or snippet. I try to insist that not everything is self-explanatory.
## Installation
Without the Ansible playbook, just clone this repo to a directory and create a few symlinks:
```sh
ln -s dotfiles-vim/.vimrc $HOME/.vimrc
ln -s dotfiles-vim/.vim $HOME/.vim
```
Clone this repo to a directory and run the `create-links.sh` script. CAUTION: this will remove any existing `.vimrc` and `.vim` directories and replace them with soft links to the files in this repository.
Then open vim and install (or update) the plugins with `:PlugInstall` (or `:PlugUpdate`)
---
* 2024-02-13: Several changes:
* Included more comments and links about what each entry does
* Removed `polyglot` plugin
* Removed `ALE` plugin
* Removed `tpope/vim-markdown` plugin
* Removed netrw customizations
* Removed auto templates, changed them to snippets:
* Insert markdown header with `,md`
* Insert shell header with `,sh`
* 2024-02-22: Replaced Vimwiki with Vim Markdown
* Suggestions from [Writing Markdown in Vim](https://codeinthehole.com/tips/writing-markdown-in-vim/)
* Added
* `godlygeek/tabular`
* `preservim/vim-markdown`
* 2024-02-25:
* Added [vim-spellsync](https://github.com/micarmst/vim-spellsync) plugin and made the needed changes to accommodate
* Reworked markdown and shell script templates to update dates in headers automatically.
* Started making better commit messages in order to avoid having to document details in README :)
## Changelog
- 2025-04-14: Removed textwidth and added a word-wrap toggle (`<leader>w`). Removed old and unused templates for markdown and readinglist.
- 2024-02-13: Several changes:
- Included more comments and links about what each entry does
- Removed `polyglot` plugin
- Removed `ALE` plugin
- Removed `tpope/vim-markdown` plugin
- Removed netrw customizations
- Removed auto templates, changed them to snippets:
- Insert markdown header with `,md`
- Insert shell header with `,sh`
- 2024-02-22: Replaced Vimwiki with Vim Markdown
- Suggestions from [Writing Markdown in Vim](https://codeinthehole.com/tips/writing-markdown-in-vim/)
- Added
- `godlygeek/tabular`
- `preservim/vim-markdown`
- 2024-02-25:
- Added [vim-spellsync](https://github.com/micarmst/vim-spellsync) plugin and made the needed changes to accommodate
- Reworked markdown and shell script templates to update dates in headers automatically.
- Started making better commit messages in order to avoid having to document details in README :)