Learn-Vim README

The project's README from github.com/iggredible/Learn-Vim. As one markdown file: README.md.

Learn Vim (the Smart Way)

What's This?

Learn Vim (the Smart Way) is a guide to learn the good parts of Vim.

There are many places to learn Vim: the vimtutor is a great place to start and the help manual has all the references you will ever need. However, the average user needs something more than vimtutor and less than the help manual. This guide attempts to bridge that gap by highlighting only the key features to learn the most useful parts of Vim in the least amount of time possible.

This guide is written for both beginner and advanced Vimmers. It starts out with broad and simple concepts and ends with specific and advanced concepts. If you're an advanced user already, I encourage you to read this guide from start to finish anyway, because you may learn something new!

Read Locally (with Docker)

You can read this book locally with Docker. Just run:

docker compose -f book/docker-compose.yml up --build

Then open http://localhost:8080.

I Want More Vim Tips!

I sometimes blog about Vim on my personal site, irian.to.

Follow @learnvim for updates, Vim tips, etc.

Support This Project

This guide is and will always be free.

If you want to financially support this project, you can either purchase this guide on Leanpub or buy me a coffee!

Buy Me A Coffee

Table Of Contents

Prologue

Part 1: Learn Vim the Smart Way

Part 2: Customize Vim the Smart Way

Part 3: Learn Vimscript the Smart Way

Translations

The materials here are all © 2020-2021 Igor Irianto.

Creative Commons License

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International.

Learn-Vim (iggredible/Learn-Vim)

Searching Database…

15.3K ·GitHub
What is this?Learn Vim (the Smart Way) is a free guide book that teaches the useful parts of Vim and Vimscript without requiring you to read the entire help manual.
Is this a book or an interactive course?It is a written guide/book organized into chapters, structured similarly to a book with a table of contents, not an interactive tutorial like vimtutor.
How is the book organized and where do I start?It is split into three parts: learning Vim itself (Ch 1-21), customizing Vim (Ch 22-24), and learning Vimscript (Ch 25-29). It starts broad and simple and ends with specific, advanced topics, so beginners can start at Chapter 0 and advanced users can skim through too.
Do I need Docker to read it?No, Docker is optional — it's just offered as one way to read the book locally; you can also read it directly on GitHub or buy it on Leanpub.
Who is this guide for?It's written for both Vim beginners and advanced users — beginners get a smooth on-ramp, while experienced Vimmers are encouraged to read it anyway since it covers advanced topics like Vimscript and plugin writing.
Can I use or copy this guide freely?The guide is free to read, but the content is copyrighted by the author and licensed under a specific license (not public domain), so redistribution terms apply.
What languages is the book translated into?It has community translations into Simplified Chinese (zh-CN) and Spanish (es), alongside the original English version.
Does the book cover writing my own Vim plugins?Yes, the final chapter (Ch 29) walks through writing a Titlecase plugin as a practical Vimscript example.
Can I support the author financially?Yes, you can buy the guide on Leanpub or support the author with a coffee donation, though the guide itself remains free to read online.
Does it cover using Git and compiling from within Vim?Yes, dedicated chapters cover Git integration (Ch 18) and compiling (Ch 19) as part of the core Vim workflow chapters.
Creator
iggredible
Size
1.9 MB
Stars
15.3K
Updated
CommitSep 07
Age
6y
Commits · 90 Days