|
| 1 | +--- |
| 2 | +layout: default |
| 3 | +title: Documentation |
| 4 | +canonical_url: /doc/ |
| 5 | +--- |
| 6 | + |
| 7 | +{% include nav.html active='Documentation' %} |
| 8 | + |
| 9 | +<section class="front-section"> |
| 10 | + <div class="container"> |
| 11 | + <h1>Documentation</h1> |
| 12 | + </div> |
| 13 | + <div class="container golden-grid"> |
| 14 | + <div> |
| 15 | + <h2>User</h2> |
| 16 | + |
| 17 | + <h3><a href="https://github.com/neovim/neovim/wiki/Installing-Neovim">Install</a></h3> |
| 18 | + <p> |
| 19 | + <a href="https://github.com/neovim/neovim/releases">Download</a> an archive |
| 20 | + or use a <a href="https://github.com/neovim/neovim/wiki/Installing-Neovim#install-from-package">package manager</a>. |
| 21 | + </p> |
| 22 | + |
| 23 | + <h3><a href="https://github.com/neovim/neovim/wiki/FAQ">FAQ</a></h3> |
| 24 | + <p> |
| 25 | + Check the <a href="https://github.com/neovim/neovim/wiki/FAQ">FAQ</a> |
| 26 | + and <a href="https://github.com/neovim/neovim/wiki/Following-HEAD">breaking changes</a> for solutions to common issues. |
| 27 | + The <a href="http://vimhelp.appspot.com/vim_faq.txt.html">Vim FAQ</a> is also useful. |
| 28 | + </p> |
| 29 | + |
| 30 | + <h3> |
| 31 | + <a href="http://neovim.io/doc/user">User manual</a> |
| 32 | + </h3> |
| 33 | + <p> |
| 34 | + This is the online form of Nvim's <a href="http://neovim.io/doc/user/"><code>:help</code></a> system. |
| 35 | + <ul> |
| 36 | + <li>Neovim features are documented at <a href="https://neovim.io/doc/user/vim_diff.html#nvim-features"><code>:help nvim-features</code></a>.</li> |
| 37 | + <li><a href="http://neovim.io/doc/user/quickref.html"><code>:help quickref</code></a> is a handy cheatsheet.</li> |
| 38 | + <li>Read <a href="https://neovim.io/doc/user/nvim.html#nvim-from-vim"><code>:help nvim-from-vim</code></a> if you already use Vim.</li> |
| 39 | + </ul> |
| 40 | + </p> |
| 41 | + </div> |
| 42 | + <div> |
| 43 | + <h2>Developer</h2> |
| 44 | + |
| 45 | + <h3><a href="https://neovim.io/doc/user/develop.html#dev"><code>:help dev</code></a></h3> |
| 46 | + <p> |
| 47 | + Design constraints and guidelines, for developing Nvim applications or Nvim itself. |
| 48 | + </p> |
| 49 | + |
| 50 | + <h3><a href="https://github.com/neovim/neovim/wiki#developers">Developer Wiki</a></h3> |
| 51 | + <p> |
| 52 | + Notes on building, navigating, and debugging. |
| 53 | + </p> |
| 54 | + <h3><a href="/doc/dev/files.html">Source documentation</a></h3> |
| 55 | + <p> |
| 56 | + Generated from source code docstrings. |
| 57 | + </p> |
| 58 | + <h3><a href="https://sourcegraph.com/github.com/neovim/neovim">SourceGraph</a></h3> |
| 59 | + <p> |
| 60 | + Navigate the Nvim source code online. |
| 61 | + </p> |
| 62 | + |
| 63 | + </div> |
| 64 | + </div> |
| 65 | +</section> |
0 commit comments