Skip to content
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
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Rynzier
Copy link

@Rynzier Rynzier commented Oct 5, 2024

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.

@AThousandShips 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.
Copy link
Member

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:
Copy link
Member

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.
Copy link
Member

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants