-
-
Notifications
You must be signed in to change notification settings - Fork 3.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Page Explaining Engine Dev Setup for Neovim Editor #10049
Open
Rynzier
wants to merge
3
commits into
godotengine:master
Choose a base branch
from
Rynzier:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+52
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AThousandShips
added
enhancement
content:new page
Issues and PRs related to creation of new documentation pages for new or undocumented features
area:contributing
Issues and PRs related to the Contributing/Development section of the documentation
labels
Oct 7, 2024
Setting Up Neovim | ||
----------------- | ||
|
||
Neovim is configured with a lua scripting API, it is recommended to use a package manager such as `lazy.nvim <https://github.com/folke/lazy.nvim>`__ to make management of plugins and configs easier. Users new to Neovim can use an existing distribution, or pre-made configs to get started. See `kickstart.nvim <https://github.com/nvim-lua/kickstart.nvim>`__ for an effective starting point for a custom neovim config, as it includes most basic functionality pre-configured and has comments explaining various components. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
Neovim is configured with a lua scripting API, it is recommended to use a package manager such as `lazy.nvim <https://github.com/folke/lazy.nvim>`__ to make management of plugins and configs easier. Users new to Neovim can use an existing distribution, or pre-made configs to get started. See `kickstart.nvim <https://github.com/nvim-lua/kickstart.nvim>`__ for an effective starting point for a custom neovim config, as it includes most basic functionality pre-configured and has comments explaining various components. | |
Neovim is configured with a lua scripting API, it is recommended to use a package manager such as `lazy.nvim <https://github.com/folke/lazy.nvim>`__ to make management of plugins and configs easier. | |
Users new to Neovim can use an existing distribution, or pre-made configs to get started. | |
See `kickstart.nvim <https://github.com/nvim-lua/kickstart.nvim>`__ for an effective starting point for a custom neovim config, | |
as it includes most basic functionality pre-configured and has comments explaining various components. |
Break up long lines
@@ -0,0 +1,52 @@ | |||
.. _doc_configuring_an_ide_rider: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
.. _doc_configuring_an_ide_rider: | |
.. _doc_configuring_an_ide_neovim: |
====== | ||
|
||
`Neovim <https://neovim.io/>`__ is a hyper-extensible vim-based editor that is fully free to use and open-source under the Apache 2.0 license. | ||
On it's own, it is as simple as a plain-text editor, but with plugins it can be extended to be a fully fledged IDE of your own design. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
On it's own, it is as simple as a plain-text editor, but with plugins it can be extended to be a fully fledged IDE of your own design. | |
On its own, it is as simple as a plain-text editor, but with plugins it can be extended to be a fully fledged IDE of your own design. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
area:contributing
Issues and PRs related to the Contributing/Development section of the documentation
content:new page
Issues and PRs related to creation of new documentation pages for new or undocumented features
enhancement
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just figured out setting this whole deal up myself, and I figured it'd be nice to leave some helpful instructions for future users wanting to use Neovim to develop Godot.