|
| 1 | +<!DOCTYPE html> |
| 2 | +<html lang="en"> |
| 3 | + <head> |
| 4 | + <meta charset="utf-8"> |
| 5 | + <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| 6 | + <meta name="viewport" content="width=device-width, initial-scale=1"> |
| 7 | + <meta name="description" content="vim out of the box"> |
| 8 | + <link type="application/atom+xml" rel="alternate" href="https://neovim.io/news.xml" title="Neovim" /> |
| 9 | + <title>Documentation - Neovim</title> |
| 10 | + |
| 11 | + <!-- algolia docsearch https://docsearch.algolia.com/docs/docsearch-v3/ --> |
| 12 | + <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3" /> |
| 13 | + <link rel="preconnect" href="https://X185E15FPG-dsn.algolia.net" crossorigin /> |
| 14 | + |
| 15 | + <link href="/css/bootstrap.min.css" rel="stylesheet"> |
| 16 | + |
| 17 | + <link href="/css/main.css" rel="stylesheet"> |
| 18 | + <link href="/css/neovim-hi.css" rel="stylesheet"> |
| 19 | + <link rel="canonical" href="https://neovim.io/doc/" /> |
| 20 | + </head> |
| 21 | + |
| 22 | + <body> |
| 23 | + <header class="container"> |
| 24 | + <nav class="navbar navbar-expand-lg"> |
| 25 | + <div class="container-fluid"> |
| 26 | + <a href="/" class="navbar-brand" aria-label="logo"> |
| 27 | + <svg xmlns="http://www.w3.org/2000/svg" role="img" width="173" height="50" viewbox="0 0 742 214" aria-label="Neovim"> |
| 28 | + <title>Neovim</title> |
| 29 | + <defs> |
| 30 | + <lineargradient x1="50%" y1="0%" x2="50%" y2="100%" id="a"> |
| 31 | + <stop stop-color="#16B0ED" stop-opacity=".8" offset="0%"></stop> |
| 32 | + <stop stop-color="#0F59B2" stop-opacity=".837" offset="100%"></stop> |
| 33 | + </lineargradient> |
| 34 | + <lineargradient x1="50%" y1="0%" x2="50%" y2="100%" id="b"> |
| 35 | + <stop stop-color="#7DB643" offset="0%"></stop> |
| 36 | + <stop stop-color="#367533" offset="100%"></stop> |
| 37 | + </lineargradient> |
| 38 | + <lineargradient x1="50%" y1="0%" x2="50%" y2="100%" id="c"> |
| 39 | + <stop stop-color="#88C649" stop-opacity=".8" offset="0%"></stop> |
| 40 | + <stop stop-color="#439240" stop-opacity=".84" offset="100%"></stop> |
| 41 | + </lineargradient> |
| 42 | + </defs> |
| 43 | + <g fill="none" fill-rule="evenodd"> |
| 44 | + <path d="M.027 45.459L45.224-.173v212.171L.027 166.894V45.459z" fill="url(#a)" transform="translate(1 1)"></path> |
| 45 | + <path d="M129.337 45.89L175.152-.149l-.928 212.146-45.197-45.104.31-121.005z" fill="url(#b)" transform="matrix(-1 0 0 1 305 1)"></path> |
| 46 | + <path d="M45.194-.137L162.7 179.173l-32.882 32.881L12.25 33.141 45.194-.137z" fill="url(#c)" transform="translate(1 1)"></path> |
| 47 | + <path d="M46.234 84.032l-.063 7.063-36.28-53.563 3.36-3.422 32.983 49.922z" fill-opacity=".13" fill="#000"></path> |
| 48 | + <g fill="#444"> |
| 49 | + <path d="M227 154V64.44h4.655c1.55 0 2.445.75 2.685 2.25l.806 13.502c4.058-5.16 8.786-9.316 14.188-12.466 5.4-3.15 11.413-4.726 18.037-4.726 4.893 0 9.205.781 12.935 2.34 3.729 1.561 6.817 3.811 9.264 6.751 2.448 2.942 4.297 6.48 5.55 10.621 1.253 4.14 1.88 8.821 1.88 14.042V154h-8.504V96.754c0-8.402-1.91-14.987-5.729-19.757-3.82-4.771-9.667-7.156-17.544-7.156-5.851 0-11.28 1.516-16.292 4.545-5.013 3.032-9.489 7.187-13.427 12.467V154H227zM350.624 63c5.066 0 9.755.868 14.069 2.605 4.312 1.738 8.052 4.268 11.219 7.592s5.638 7.412 7.419 12.264C385.11 90.313 386 95.883 386 102.17c0 1.318-.195 2.216-.588 2.696-.393.48-1.01.719-1.851.719h-64.966v1.70c0 6.708.784 12.609 2.353 17.7 1.567 5.09 3.8 9.357 6.695 12.802 2.895 3.445 6.393 6.034 10.495 7.771 4.1 1.738 8.686 2.606 13.752 2.606 4.524 0 8.446-.494 11.762-1.483 3.317-.988 6.108-2.097 8.37-3.324 2.261-1.227 4.056-2.336 5.383-3.324 1.326-.988 2.292-1.482 2.895-1.482.784 0 1.388.3 1.81.898l2.352 2.875c-1.448 1.797-3.362 3.475-5.745 5.031-2.383 1.558-5.038 2.891-7.962 3.998-2.926 1.109-6.062 1.991-9.41 2.65a52.21 52.21 0 01-10.088.989c-6.152 0-11.762-1.064-16.828-3.19-5.067-2.125-9.415-5.225-13.043-9.298-3.63-4.074-6.435-9.06-8.415-14.96C310.99 121.655 310 114.9 310 107.294c0-6.408.92-12.323 2.76-17.744 1.84-5.421 4.493-10.093 7.961-14.016 3.467-3.922 7.72-6.991 12.758-9.209C338.513 64.11 344.229 63 350.624 63zm.573 6c-4.696 0-8.904.702-12.623 2.105-3.721 1.404-6.936 3.421-9.65 6.053-2.713 2.631-4.908 5.79-6.586 9.474S319.55 94.439 319 99h60c0-4.679-.672-8.874-2.013-12.588-1.343-3.712-3.232-6.856-5.67-9.43-2.44-2.571-5.367-4.545-8.782-5.92-3.413-1.374-7.192-2.062-11.338-2.062zM435.546 63c6.526 0 12.368 1.093 17.524 3.28 5.154 2.186 9.5 5.286 13.04 9.298 3.538 4.013 6.238 8.85 8.099 14.51 1.861 5.66 2.791 11.994 2.791 19.002 0 7.008-.932 13.327-2.791 18.957-1.861 5.631-4.561 10.452-8.099 14.465-3.54 4.012-7.886 7.097-13.04 9.254-5.156 2.156-10.998 3.234-17.524 3.234-6.529 0-12.369-1.078-17.525-3.234-5.155-2.157-9.517-5.242-13.085-9.254-3.57-4.013-6.285-8.836-8.145-14.465-1.861-5.63-2.791-11.95-2.791-18.957 0-7.008.93-13.342 2.791-19.002 1.861-5.66 4.576-10.496 8.145-14.51 3.568-4.012 7.93-7.112 13.085-9.299C423.177 64.094 429.017 63 435.546 63zm-.501 86c5.341 0 10.006-.918 13.997-2.757 3.99-1.838 7.32-4.474 9.992-7.909 2.67-3.435 4.664-7.576 5.986-12.428 1.317-4.85 1.98-10.288 1.98-16.316 0-5.965-.66-11.389-1.98-16.27-1.322-4.88-3.316-9.053-5.986-12.519-2.67-3.463-6-6.13-9.992-7.999-3.991-1.867-8.657-2.802-13.997-2.802s-10.008.935-13.997 2.802c-3.991 1.87-7.322 4.536-9.992 8-2.671 3.465-4.68 7.637-6.03 12.518-1.35 4.881-2.026 10.305-2.026 16.27 0 6.026.675 11.465 2.025 16.316 1.35 4.852 3.36 8.993 6.031 12.428 2.67 3.435 6 6.07 9.992 7.91 3.99 1.838 8.656 2.756 13.997 2.756z" fill="currentColor"></path> |
| 50 | + <path d="M530.57 152h-20.05L474 60h18.35c1.61 0 2.967.39 4.072 1.166 1.103.778 1.865 1.763 2.283 2.959l17.722 49.138a92.762 92.762 0 012.551 8.429c.686 2.751 1.298 5.5 1.835 8.25.537-2.75 1.148-5.499 1.835-8.25a77.713 77.713 0 012.64-8.429l18.171-49.138c.417-1.196 1.164-2.181 2.238-2.96 1.074-.776 2.356-1.165 3.849-1.165H567l-36.43 92zM572 61h23v92h-23zM610 153V60.443h13.624c2.887 0 4.78 1.354 5.682 4.06l1.443 6.856a52.7 52.7 0 015.097-4.962 32.732 32.732 0 015.683-3.879 30.731 30.731 0 016.496-2.57c2.314-.632 4.855-.948 7.624-.948 5.832 0 10.63 1.579 14.39 4.736 3.758 3.157 6.57 7.352 8.434 12.585 1.444-3.068 3.248-5.698 5.413-7.894 2.165-2.194 4.541-3.984 7.127-5.367a32.848 32.848 0 018.254-3.068 39.597 39.597 0 018.796-.992c5.111 0 9.653.783 13.622 2.345 3.97 1.565 7.307 3.849 10.014 6.857 2.706 3.007 4.766 6.675 6.18 11.005C739.29 83.537 740 88.5 740 94.092V153h-22.284V94.092c0-5.894-1.294-10.329-3.878-13.306-2.587-2.977-6.376-4.465-11.368-4.465-2.286 0-4.404.391-6.358 1.172a15.189 15.189 0 00-5.144 3.383c-1.473 1.474-2.631 3.324-3.474 5.548-.842 2.225-1.263 4.781-1.263 7.668V153h-22.37V94.092c0-6.194-1.249-10.704-3.744-13.532-2.497-2.825-6.18-4.24-11.051-4.24-3.19 0-6.18.798-8.976 2.391-2.799 1.593-5.399 3.775-7.804 6.54V153H610zM572 30h23v19h-23z" fill="currentColor" fill-opacity=".8"></path> |
| 51 | + </g> |
| 52 | + </g> |
| 53 | +</svg> |
| 54 | + |
| 55 | + </a> |
| 56 | + |
| 57 | + <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav" aria-expanded="false" aria-label="Main menu"> |
| 58 | + <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewbox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"> |
| 59 | + <line x1="3" y1="12" x2="21" y2="12"></line> |
| 60 | + <line x1="3" y1="6" x2="21" y2="6"></line> |
| 61 | + <line x1="3" y1="18" x2="21" y2="18"></line> |
| 62 | + </svg> |
| 63 | + </button> |
| 64 | + |
| 65 | + <div class="collapse navbar-collapse justify-content-end" id="navbarNav"> |
| 66 | + <ul class="navbar-nav"> |
| 67 | + |
| 68 | + |
| 69 | + |
| 70 | + |
| 71 | + |
| 72 | + <li class="nav-item dropdown"> |
| 73 | + <a class="nav-link dropdown-toggle" href="#" role="button" data-bs-toggle="dropdown" aria-expanded="false" id="neovimDropdown">About</a> |
| 74 | + <ul class="dropdown-menu" aria-labelledby="neovimDropdown"> |
| 75 | + |
| 76 | + |
| 77 | + <li> |
| 78 | + <a class="dropdown-item" href="/charter/"> |
| 79 | + Vision |
| 80 | + </a> |
| 81 | + </li> |
| 82 | + |
| 83 | + |
| 84 | + |
| 85 | + <li> |
| 86 | + <a class="dropdown-item" href="/roadmap/"> |
| 87 | + Roadmap |
| 88 | + </a> |
| 89 | + </li> |
| 90 | + |
| 91 | + |
| 92 | + |
| 93 | + <li> |
| 94 | + <a class="dropdown-item" href="/screenshots/"> |
| 95 | + Screenshots |
| 96 | + </a> |
| 97 | + </li> |
| 98 | + |
| 99 | + |
| 100 | + </ul> |
| 101 | + </li> |
| 102 | + |
| 103 | + |
| 104 | + |
| 105 | + |
| 106 | + <li class="nav-item"> |
| 107 | + <a href="/news/" class="nav-link">News</a> |
| 108 | + </li> |
| 109 | + |
| 110 | + |
| 111 | + |
| 112 | + |
| 113 | + |
| 114 | + <li class="nav-item"> |
| 115 | + <a href="https://github.com/neovim/neovim" class="nav-link">Development</a> |
| 116 | + </li> |
| 117 | + |
| 118 | + |
| 119 | + |
| 120 | + |
| 121 | + |
| 122 | + <li class="nav-item"> |
| 123 | + <a href="/doc/" class="nav-link">Documentation</a> |
| 124 | + </li> |
| 125 | + |
| 126 | + |
| 127 | + |
| 128 | + |
| 129 | + |
| 130 | + <li class="nav-item"> |
| 131 | + <a href="/sponsors/" class="nav-link">Sponsors</a> |
| 132 | + </li> |
| 133 | + |
| 134 | + |
| 135 | + |
| 136 | + |
| 137 | + |
| 138 | + <li class="nav-item"> |
| 139 | + <a href="https://store.neovim.io/" class="nav-link">Store</a> |
| 140 | + </li> |
| 141 | + |
| 142 | + |
| 143 | + </ul> |
| 144 | + </div> |
| 145 | + |
| 146 | + <!-- algolia docsearch https://docsearch.algolia.com/docs/docsearch-v3/ --> |
| 147 | + <div id="docsearch"></div> |
| 148 | + |
| 149 | + </div> |
| 150 | + </nav> |
| 151 | +</header> |
| 152 | + |
| 153 | + |
| 154 | +<section class="front-section"> |
| 155 | + <div class="container"> |
| 156 | + <h1>Documentation</h1> |
| 157 | + </div> |
| 158 | + <div class="container golden-grid"> |
| 159 | + <div> |
| 160 | + <h2>User</h2> |
| 161 | + |
| 162 | + <h3><a href="https://github.com/neovim/neovim/blob/master/INSTALL.md">Install</a></h3> |
| 163 | + <p> |
| 164 | + <a href="https://github.com/neovim/neovim/releases">Download a binary</a> |
| 165 | + or use a <a href="https://github.com/neovim/neovim/blob/master/INSTALL.md#install-from-package">package manager</a>. |
| 166 | + </p> |
| 167 | + |
| 168 | + <h3> |
| 169 | + <a href="https://neovim.io/doc/user">User documentation</a> |
| 170 | + </h3> |
| 171 | + <p> |
| 172 | + </p> |
| 173 | +<ul> |
| 174 | + <li>Neovim features: <a href="/doc/user/vim_diff.html#nvim-features"><code>:help nvim-features</code></a> |
| 175 | +</li> |
| 176 | + <li>Read <a href="/doc/user/nvim.html#nvim-from-vim"><code>:help nvim-from-vim</code></a> if you already use Vim.</li> |
| 177 | + <li>Read about <a href="/doc/user/lua.html">Lua in Nvim</a> |
| 178 | +</li> |
| 179 | + <li>Check the <a href="https://neovim.io/doc/user/faq.html#faq">FAQ</a> |
| 180 | + and <a href="https://neovim.io/doc/user/news.html#news-breaking">breaking changes</a> for common issues.</li> |
| 181 | + </ul> |
| 182 | + |
| 183 | + |
| 184 | + </div> |
| 185 | + <div> |
| 186 | + <h2>Developer</h2> |
| 187 | + |
| 188 | + <h3>Resources</h3> |
| 189 | + <ul> |
| 190 | + <li><a href="https://github.com/neovim/neovim/blob/master/BUILD.md">Building Nvim from source</a></li> |
| 191 | + <li><a href="https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md">Contributing to Neovim</a></li> |
| 192 | + <li> |
| 193 | +<a href="https://neovim.io/doc/user/develop.html#dev"><code>:help dev</code></a> guidelines and design constraints</li> |
| 194 | + <li> |
| 195 | +<a href="https://neovim.io/doc/user/dev_tools.html#dev-tools"><code>:help dev-tools</code></a> tools and techniques</li> |
| 196 | + <li> |
| 197 | +<a href="https://sourcegraph.com/github.com/neovim/neovim">Sourcegraph</a> for exploring Nvim's source code</li> |
| 198 | + </ul> |
| 199 | + |
| 200 | + <h3>API clients</h3> |
| 201 | + <ul> |
| 202 | + <li><a href="https://neovim.io/node-client/">node-client (Node.js client)</a></li> |
| 203 | + <li><a href="https://pynvim.readthedocs.io/">pynvim (python client)</a></li> |
| 204 | + <li><a href="https://rubydoc.info/gems/neovim">neovim-ruby client</a></li> |
| 205 | + <li><a href="https://pkg.go.dev/github.com/neovim/go-client">go-client</a></li> |
| 206 | + <li><a href="https://github.com/neovim/neovim/wiki/Related-projects#api-clients">More clients (third-party)</a></li> |
| 207 | + </ul> |
| 208 | + |
| 209 | + </div> |
| 210 | + </div> |
| 211 | +</section> |
| 212 | + |
| 213 | + |
| 214 | + <footer> |
| 215 | + <div class="container flex"> |
| 216 | + <div> |
| 217 | + |
| 218 | + <a href="/about/">About</a> |
| 219 | + |
| 220 | + · |
| 221 | + |
| 222 | + |
| 223 | + <a href="/news/">News</a> |
| 224 | + |
| 225 | + · |
| 226 | + |
| 227 | + |
| 228 | + <a href="https://github.com/neovim/neovim">Development</a> |
| 229 | + |
| 230 | + · |
| 231 | + |
| 232 | + |
| 233 | + <a href="/doc/">Documentation</a> |
| 234 | + |
| 235 | + · |
| 236 | + |
| 237 | + |
| 238 | + <a href="/sponsors/">Sponsors</a> |
| 239 | + |
| 240 | + · |
| 241 | + |
| 242 | + |
| 243 | + <a href="https://store.neovim.io/">Store</a> |
| 244 | + |
| 245 | + |
| 246 | + · |
| 247 | + <a rel="me" href="https://hachyderm.io/@neovim">Mastodon</a> |
| 248 | + </div> |
| 249 | + |
| 250 | + <div> |
| 251 | + This site's source is <a href="https://github.com/neovim/neovim.github.io/">hosted on GitHub</a>. |
| 252 | + </div> |
| 253 | + </div> |
| 254 | +</footer> |
| 255 | + |
| 256 | + |
| 257 | + <script src="/js/bootstrap.bundle.min.js"></script> |
| 258 | + |
| 259 | + <!-- algolia docsearch https://docsearch.algolia.com/docs/docsearch-v3/ --> |
| 260 | + <script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3"></script> |
| 261 | + <script type="module"> |
| 262 | + docsearch({ |
| 263 | + container: '#docsearch', |
| 264 | + appId: 'X185E15FPG', |
| 265 | + apiKey: 'b5e6b2f9c636b2b471303205e59832ed', |
| 266 | + indexName: 'nvim', |
| 267 | + }); |
| 268 | + </script> |
| 269 | + |
| 270 | + </body> |
| 271 | +</html> |
0 commit comments