mirror of
https://github.com/foo-dogsquared/wiki.git
synced 2025-02-07 06:19:03 +00:00
19 lines
8.9 KiB
HTML
19 lines
8.9 KiB
HTML
<!DOCTYPE html><html><head><meta name="viewport" content="width=device-width"/><meta charSet="utf-8"/><title>Neovim help system</title><script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script><script id="MathJax-script" async="" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script><script type="text/x-mathjax-config">
|
|
MathJax = {
|
|
tex: {
|
|
inlineMath: [ ['$','$'], ['\(','\)'] ],
|
|
displayMath: [ ['$$','$$'], ['[',']'] ]
|
|
},
|
|
options = {
|
|
processHtmlClass = "math"
|
|
}
|
|
}
|
|
</script><meta name="next-head-count" content="6"/><link rel="preload" href="/wiki/_next/static/css/52fc2ba29703df73922c.css" as="style"/><link rel="stylesheet" href="/wiki/_next/static/css/52fc2ba29703df73922c.css" data-n-g=""/><noscript data-n-css=""></noscript><link rel="preload" href="/wiki/_next/static/chunks/main-ae4733327bd95c4ac325.js" as="script"/><link rel="preload" href="/wiki/_next/static/chunks/webpack-50bee04d1dc61f8adf5b.js" as="script"/><link rel="preload" href="/wiki/_next/static/chunks/framework.9d524150d48315f49e80.js" as="script"/><link rel="preload" href="/wiki/_next/static/chunks/commons.0e1c3f9aa780c2dfe9f0.js" as="script"/><link rel="preload" href="/wiki/_next/static/chunks/pages/_app-8e3d0c58a60ec788aa69.js" as="script"/><link rel="preload" href="/wiki/_next/static/chunks/940643274e605e7596ecea1f2ff8d83317a3fb76.4841a16762f602a59f00.js" as="script"/><link rel="preload" href="/wiki/_next/static/chunks/pages/%5B%5B...slug%5D%5D-1aa198f87ede1cd0e1dc.js" as="script"/></head><body><div id="__next"><main><h1>Neovim help system</h1><section class="post-metadata"><span>Date: <!-- -->2022-04-01 16:20:55 +08:00</span><span>Date modified: <!-- -->2022-04-20 19:04:55 +08:00</span></section><nav class="toc"><ol class="toc-level toc-level-1"></ol></nav><ul><li><p>the main command is <code class="inline-verbatim">:h</code> which should open <code class="inline-verbatim">help.txt</code> if given no arguments;
|
|
this should be enough if you want to explore much of Neovim itself as the document has an index of tutorials and local additions (most likely from the installed plugins)
|
|
</p></li><li><p>the help documents are written in a custom formatting language that is recognized as a separate filetype;
|
|
in addition to navigating the buffer like any other buffer, you can also run <code class="inline-verbatim">gO</code> to show the table of contents
|
|
</p></li><li><p>if given an argument, Vim will open the section of the document with the closest match
|
|
</p></li><li><p>some points of interest
|
|
</p><ul><li><p>you can view the complete listing of help tags with <code class="inline-verbatim">help-tags</code></p></li><li><p>there is also a index of tags from <code class="inline-verbatim">index.txt</code></p></li><li><p>you can easily get the keybind with <code class="inline-verbatim">CTRL-V</code> (e.g., <code class="inline-verbatim">CTRL-V</code> then <code class="inline-verbatim">META-D</code> will quickly print the keymap)
|
|
</p></li><li><p>tab completion is present
|
|
</p></li></ul></li></ul><section><h2>Backlinks</h2><ul><li><a href="/wiki/2021-04-06-22-25-17">Prefer referencing over remembering</a></li><li><a href="/wiki/editor.neovim.folds">Neovim folds</a></li><li><a href="/wiki/editor.neovim.lua-modules">Neovim Lua modules</a></li><li><a href="/wiki/editor.neovim.lua">Neovim Lua integration</a></li><li><a href="/wiki/editor.neovim.plugins.luasnip">Neovim plugin: LuaSnip</a></li><li><a href="/wiki/editor.neovim.text-objects">Neovim text objects</a></li></ul></section></main></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"metadata":{"date":"2022-04-01 16:20:55 +08:00","date_modified":"2022-04-20 19:04:55 +08:00","language":"en","source":""},"title":"Neovim help system","hast":{"type":"root","children":[{"type":"element","tagName":"nav","properties":{"className":"toc"},"children":[{"type":"element","tagName":"ol","properties":{"className":"toc-level toc-level-1"},"children":[]}]},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"the main command is "},{"type":"element","tagName":"code","properties":{"className":["inline-verbatim"]},"children":[{"type":"text","value":":h"}]},{"type":"text","value":" which should open "},{"type":"element","tagName":"code","properties":{"className":["inline-verbatim"]},"children":[{"type":"text","value":"help.txt"}]},{"type":"text","value":" if given no arguments;\n this should be enough if you want to explore much of Neovim itself as the document has an index of tutorials and local additions (most likely from the installed plugins)\n"}]}]},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"the help documents are written in a custom formatting language that is recognized as a separate filetype;\n in addition to navigating the buffer like any other buffer, you can also run "},{"type":"element","tagName":"code","properties":{"className":["inline-verbatim"]},"children":[{"type":"text","value":"gO"}]},{"type":"text","value":" to show the table of contents\n"}]}]},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"if given an argument, Vim will open the section of the document with the closest match\n"}]}]},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"some points of interest\n"}]},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"you can view the complete listing of help tags with "},{"type":"element","tagName":"code","properties":{"className":["inline-verbatim"]},"children":[{"type":"text","value":"help-tags"}]}]}]},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"there is also a index of tags from "},{"type":"element","tagName":"code","properties":{"className":["inline-verbatim"]},"children":[{"type":"text","value":"index.txt"}]}]}]},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"you can easily get the keybind with "},{"type":"element","tagName":"code","properties":{"className":["inline-verbatim"]},"children":[{"type":"text","value":"CTRL-V"}]},{"type":"text","value":" (e.g., "},{"type":"element","tagName":"code","properties":{"className":["inline-verbatim"]},"children":[{"type":"text","value":"CTRL-V"}]},{"type":"text","value":" then "},{"type":"element","tagName":"code","properties":{"className":["inline-verbatim"]},"children":[{"type":"text","value":"META-D"}]},{"type":"text","value":" will quickly print the keymap)\n"}]}]},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"tab completion is present\n"}]}]}]}]}]}]},"backlinks":[{"path":"/2021-04-06-22-25-17","title":"Prefer referencing over remembering"},{"path":"/editor.neovim.folds","title":"Neovim folds"},{"path":"/editor.neovim.lua-modules","title":"Neovim Lua modules"},{"path":"/editor.neovim.lua","title":"Neovim Lua integration"},{"path":"/editor.neovim.plugins.luasnip","title":"Neovim plugin: LuaSnip"},{"path":"/editor.neovim.text-objects","title":"Neovim text objects"}]},"__N_SSG":true},"page":"/[[...slug]]","query":{"slug":["editor.neovim.help-system"]},"buildId":"Ie9t5zutrXP6Of75Cb5xF","assetPrefix":"/wiki","nextExport":false,"isFallback":false,"gsp":true}</script><script nomodule="" src="/wiki/_next/static/chunks/polyfills-99d808df29361cf7ffb1.js"></script><script src="/wiki/_next/static/chunks/main-ae4733327bd95c4ac325.js" async=""></script><script src="/wiki/_next/static/chunks/webpack-50bee04d1dc61f8adf5b.js" async=""></script><script src="/wiki/_next/static/chunks/framework.9d524150d48315f49e80.js" async=""></script><script src="/wiki/_next/static/chunks/commons.0e1c3f9aa780c2dfe9f0.js" async=""></script><script src="/wiki/_next/static/chunks/pages/_app-8e3d0c58a60ec788aa69.js" async=""></script><script src="/wiki/_next/static/chunks/940643274e605e7596ecea1f2ff8d83317a3fb76.4841a16762f602a59f00.js" async=""></script><script src="/wiki/_next/static/chunks/pages/%5B%5B...slug%5D%5D-1aa198f87ede1cd0e1dc.js" async=""></script><script src="/wiki/_next/static/Ie9t5zutrXP6Of75Cb5xF/_buildManifest.js" async=""></script><script src="/wiki/_next/static/Ie9t5zutrXP6Of75Cb5xF/_ssgManifest.js" async=""></script></body></html> |