Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/learnbyexample/vim_reference

:q Vim Reference Guide for beginner to intermediate level users
https://github.com/learnbyexample/vim_reference

ebook vim

Last synced: 4 days ago
JSON representation

:q Vim Reference Guide for beginner to intermediate level users

Awesome Lists containing this project

README 

        
# Vim Reference Guide



**Vim Reference Guide** is intended as a concise learning resource for beginner to intermediate level Vim users. It has more in common with cheatsheets than a typical text book. Topics like Regular Expressions and Macros have more detailed explanations and examples due to their complexity. Visit https://youtu.be/4ybTvTr3SQc for a short video about the book.



Vim Reference Guide ebook cover image



See [Version_changes.md](./Version_changes.md) to keep track of changes made to the book.



📹 Visit [this playlist](https://www.youtube.com/playlist?list=PLTv2U3HnAL4NN2tK-59ZiNBm-o64-Yvos) for video demos on most of the topics from the ebook.



![info](./images/info.svg) See also my [curated list on Vim](https://learnbyexample.github.io/curated_resources/vim.html) for beginner to advanced level learning resources.







# E-book



* You can purchase the pdf/epub versions of the book using these links:

   * https://learnbyexample.gumroad.com/l/vim_reference_guide

   * https://leanpub.com/vim_reference_guide

* You can also get the book as part of these bundles:

   * **Awesome Regex** bundle from https://leanpub.com/b/regex or https://learnbyexample.gumroad.com/l/regex

   * **All books bundle** from https://learnbyexample.gumroad.com/l/all-books

        * Includes all my programming books

* See https://learnbyexample.github.io/books/ for a list of other books



For a preview of the book, see [sample chapters](./sample_chapters/vim_reference_guide_sample.pdf).



The book can also be [viewed as a single markdown file in this repo](./vim_reference_guide.md). See my blogpost on [generating pdfs from markdown using pandoc](https://learnbyexample.github.io/customizing-pandoc/) if you are interested in the ebook creation process.



For web version of the book, visit https://learnbyexample.github.io/vim_reference/







# Testimonials



Got several suggestions and feedback when [my submission about this book](https://news.ycombinator.com/item?id=30684232) reached the front page of Hacker News.



>Great job on this! — rendall

>

>Hi, great work releasing this! Trying to explain vim concisely is always an interesting challenge and I had a great time reading your attempt in this book. I always find it really interesting on how people try to group certain vim functions in a way that makes sense to people that don't use vim. I think you cover that idea pretty well in your 'Vim philosophy and features' section whilst not making it overly abstract and keeping it relatable. — doix

>

>Neat stuff! One piece of feedback is that I would include "+p and "+yy in the copy and paste section. — mrpotato

>

>I learnt regular expression by reading your books, thank you for the great work. — LamJH



A comment from another [Hacker News thread](https://news.ycombinator.com/item?id=31931804):



>I stumbled upon your vi post a few days ago, really like the style. Keep it up!







# Feedback



⚠️ ⚠️ Please DO NOT submit pull requests. Main reason being any modification requires changes in multiple places.



I would highly appreciate it if you'd let me know how you felt about this book. It could be anything from a simple thank you, pointing out a typo, mistakes in code snippets, which aspects of the book worked for you (or didn't!) and so on. Reader feedback is essential and especially so for self-published authors.



You can reach me via:



* Issue Manager: [https://github.com/learnbyexample/vim_reference/issues](https://github.com/learnbyexample/vim_reference/issues)

* E-mail: `echo 'bGVhcm5ieWV4YW1wbGUubmV0QGdtYWlsLmNvbQo=' | base64 --decode`

* Twitter: [https://twitter.com/learn_byexample](https://twitter.com/learn_byexample)







# Table of Contents



1) Preface

2) Introduction

3) Insert mode

4) Normal mode

5) Command-line mode

6) Visual mode

7) Regular Expressions

8) Macro

9) Customizing Vim

10) CLI options







# Acknowledgements



* [Vim help files](https://vimhelp.org/) — user and reference manuals

* [/r/vim/](https://old.reddit.com/r/vim) and [vi.stackexchange](https://vi.stackexchange.com/) — helpful forums

* [tex.stackexchange](https://tex.stackexchange.com/) — for help on [pandoc](https://github.com/jgm/pandoc/) and `tex` related questions

* [canva](https://www.canva.com/) — cover image

* [Warning](https://commons.wikimedia.org/wiki/File:Warning_icon.svg) and [Info](https://commons.wikimedia.org/wiki/File:Info_icon_002.svg) icons by [Amada44](https://commons.wikimedia.org/wiki/User:Amada44) under public domain

* [oxipng](https://github.com/shssoichiro/oxipng), [pngquant](https://pngquant.org/) and [svgcleaner](https://github.com/RazrFalcon/svgcleaner) — for optimizing images

* [Rodrigo Girão Serrão](https://mathspp.com/) — for feedback and suggestions

* [Andy](https://twitter.com/andylondon) — for cover image suggestions

* [Inkscape](https://inkscape.org/) for favicon

* [mdBook](https://github.com/rust-lang/mdBook) — for web version of the book

    * [mdBook-pagetoc](https://github.com/JorelAli/mdBook-pagetoc) — for adding table of contents for each page

    * [minify-html](https://github.com/wilsonzlin/minify-html) — for minifying html files

    * [MDN: kbd](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/kbd) — CSS for `` tag







# License



The book is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).



The code snippets are licensed under MIT, see [LICENSE](./LICENSE) file.