mirror/LazyVim.LazyVim
1
0
Fork 0
mirror of https://github.com/LazyVim/LazyVim.git synced 2025-07-25 13:15:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(build): auto-generate vimdoc

Browse source
This commit is contained in:
github-actions[bot] 2023-02-19 21:32:05 +00:00
parent 6b9f0c0c3c
commit 90c58352dd
1 changed files with 43 additions and 78 deletions
Download patch file Download diff file Expand all files Collapse all files

121
doc/LazyVim.txt
View file

@ -1,54 +1,37 @@
*LazyVim.txt* For Neovim >= 0.8.0 Last change: 2023 February 18 *LazyVim.txt* For Neovim >= 0.8.0 Last change: 2023 February 19
============================================================================== ==============================================================================
Table of Contents *LazyVim-table-of-contents* Table of Contents *LazyVim-table-of-contents*
- Features |LazyVim-features| - Features |LazyVim-nil-features|
- Requirements |LazyVim-requirements| - Requirements |LazyVim-nil-requirements|
- Getting Started |LazyVim-getting-started| - Getting Started |LazyVim-nil-getting-started|
- File Structure |LazyVim-file-structure| - File Structure |LazyVim-nil-file-structure|
- Configuration |LazyVim-configuration| - Configuration |LazyVim-nil-configuration|
<img Install
src="https://user-images.githubusercontent.com/292349/213446185-2db63fd5-8c84-459c-9f04-e286382d6e80.png">
<hr>
<h4 align="center">
<a href="https://lazyvim.github.io/installation">Install</a>
· ·
<a href="https://lazyvim.github.io/configuration">Configure</a> Configure
· ·
<a href="https://lazyvim.github.io">Docs</a> Docs
</h4>
<div align="center">
<a href="https://github.com/LazyVim/LazyVim/releases/latest">
<img alt="Latest release" src="https://img.shields.io/github/v/release/LazyVim/LazyVim?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41&include_prerelease&sort=semver" />
</a>
<a href="https://github.com/LazyVim/LazyVim/pulse">
<img alt="Last commit" src="https://img.shields.io/github/last-commit/LazyVim/LazyVim?style=for-the-badge&logo=starship&color=8bd5ca&logoColor=D9E0EE&labelColor=302D41"/>
</a>
<a href="https://github.com/LazyVim/LazyVim/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/LazyVim/LazyVim?style=for-the-badge&logo=starship&color=ee999f&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/LazyVim/LazyVim/stargazers">
<img alt="Stars" src="https://img.shields.io/github/stars/LazyVim/LazyVim?style=for-the-badge&logo=starship&color=c69ff5&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/LazyVim/LazyVim/issues">
<img alt="Issues" src="https://img.shields.io/github/issues/LazyVim/LazyVim?style=for-the-badge&logo=bilibili&color=F5E0DC&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/LazyVim/LazyVim">
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/LazyVim/LazyVim?color=%23DDB6F2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://twitter.com/intent/follow?screen_name=folke">
<img alt="follow on Twitter" src="https://img.shields.io/twitter/follow/folke?style=for-the-badge&logo=twitter&color=8aadf3&logoColor=D9E0EE&labelColor=302D41" />
</a>
</div>
LazyVim is a Neovim setup powered by lazy.nvim LazyVim is a Neovim setup powered by lazy.nvim
<https://github.com/folke/lazy.nvim> to make it easy to customize and extend <https://github.com/folke/lazy.nvim> to make it easy to customize and extend
@ -57,17 +40,8 @@ using a pre-made distro, LazyVim offers the best of both worlds - the
flexibility to tweak your config as needed, along with the convenience of a flexibility to tweak your config as needed, along with the convenience of a
pre-configured setup. pre-configured setup.
<div class="figure">
<img src="https://user-images.githubusercontent.com/292349/211285846-0b7bb3bf-0462-4029-b64c-4ee1d037fc1c.png" title="fig:"/>
<p class="caption">image</p>
</div>
<div class="figure"> FEATURES *LazyVim-nil-features*
<img src="https://user-images.githubusercontent.com/292349/213447056-92290767-ea16-430c-8727-ce994c93e9cc.png" title="fig:"/>
<p class="caption">image</p>
</div>
FEATURES *LazyVim-features*
- Transform your Neovim into a full-fledged IDE - Transform your Neovim into a full-fledged IDE
@ -77,20 +51,20 @@ FEATURES *LazyVim-features*
- Comes with a wealth of plugins pre-configured and ready to use - Comes with a wealth of plugins pre-configured and ready to use
REQUIREMENTS *LazyVim-requirements* REQUIREMENTS *LazyVim-nil-requirements*
- Neovim >= **0.8.0** (needs to be built with **LuaJIT**) - Neovim >= **0.8.0** (needs to be built with **LuaJIT**)
- Git >= **2.19.0** (for partial clones support) - Git >= **2.19.0** (for partial clones support)
- a Nerd Font <https://www.nerdfonts.com/> **_(optional)_** - a Nerd Font <https://www.nerdfonts.com/> **(optional)**
GETTING STARTED *LazyVim-getting-started* GETTING STARTED *LazyVim-nil-getting-started*
You can find a starter template for **LazyVim** here You can find a starter template for **LazyVim** here
<https://github.com/LazyVim/starter> <https://github.com/LazyVim/starter>
Try it with Docker Try it with Docker ~
>sh >sh
docker run -w /root -it --rm alpine:edge sh -uelic ' docker run -w /root -it --rm alpine:edge sh -uelic '
@ -101,8 +75,7 @@ Try it with Docker
' '
< <
Install the LazyVim Starter ~
Install the <a href="https://github.com/LazyVim/starter">LazyVim Starter</a>
- Make a backup of your current Neovim files: - Make a backup of your current Neovim files:
@ -124,44 +97,36 @@ Install the <a href="https://github.com/LazyVim/starter">LazyVim Starter</a>
< <
Refer to the comments in the files on how to customize **LazyVim**. Refer to the comments in the files on how to customize **LazyVim**.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
There’s a great video created by @elijahmanor
<https://github.com/elijahmanor> with a walkthrough to get started.
There’s a great video created by elijahmano <https://github.com/elijahmanor>
with a walkthrough to get started.
<img src='https://img.youtube.com/vi/N93cTbtLCIM/hqdefault.jpg' title=''/>
<https://www.youtube.com/watch?v=N93cTbtLCIM> <https://www.youtube.com/watch?v=N93cTbtLCIM>
FILE STRUCTURE *LazyVim-file-structure*
FILE STRUCTURE *LazyVim-nil-file-structure*
The files under config will be automatically loaded at the appropriate time, so The files under config will be automatically loaded at the appropriate time, so
you don’t need to require those files manually. **LazyVim** comes with a set you don’t need to require those files manually. **LazyVim** comes with a set
of default config files that will be loaded **_before_** your own. See here of default config files that will be loaded **before** your own. See here
<https://github.com/LazyVim/LazyVim/tree/main/lua/lazyvim/config> <https://github.com/LazyVim/LazyVim/tree/main/lua/lazyvim/config>
You can add your custom plugin specs under `lua/plugins/`. All files there will You can add your custom plugin specs under `lua/plugins/`. All files there will
be automatically loaded by lazy.nvim <https://github.com/folke/lazy.nvim> be automatically loaded by lazy.nvim <https://github.com/folke/lazy.nvim>
<pre>
~/.config/nvim
lua
   config
      autocmds.lua
      keymaps.lua
      lazy.lua
      options.lua
   plugins
   spec1.lua
  
   spec2.lua
init.lua
</pre>
CONFIGURATION *LazyVim-configuration* CONFIGURATION *LazyVim-nil-configuration*
Refer to the docs <https://lazyvim.github.io> Refer to the docs <https://lazyvim.github.io>
==============================================================================
1. Links *LazyVim-links*
1. *image*: https://user-images.githubusercontent.com/292349/211285846-0b7bb3bf-0462-4029-b64c-4ee1d037fc1c.png
2. *image*: https://user-images.githubusercontent.com/292349/213447056-92290767-ea16-430c-8727-ce994c93e9cc.png
3. *@elijahmanor*:
4. *Watch the video*: https://img.youtube.com/vi/N93cTbtLCIM/hqdefault.jpg
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc> Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
vim:tw=78:ts=8:noet:ft=help:norl: vim:tw=78:ts=8:noet:ft=help:norl: