{"id":20498143,"url":"https://github.com/codewithtejpratab/nvim","last_synced_at":"2025-03-05T18:59:09.357Z","repository":{"id":229460399,"uuid":"775230841","full_name":"CodeWithTejpratab/nvim","owner":"CodeWithTejpratab","description":"My Neovim configfile","archived":false,"fork":false,"pushed_at":"2024-03-28T02:57:31.000Z","size":618,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-16T06:36:46.636Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CodeWithTejpratab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-21T01:57:06.000Z","updated_at":"2024-03-21T01:58:25.000Z","dependencies_parsed_at":"2024-03-24T14:47:38.542Z","dependency_job_id":"7085b610-e364-4962-b732-57d81c460fb9","html_url":"https://github.com/CodeWithTejpratab/nvim","commit_stats":null,"previous_names":["codewithtejpratab/nvim"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeWithTejpratab%2Fnvim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeWithTejpratab%2Fnvim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeWithTejpratab%2Fnvim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeWithTejpratab%2Fnvim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CodeWithTejpratab","download_url":"https://codeload.github.com/CodeWithTejpratab/nvim/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242087919,"owners_count":20069722,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T18:13:12.241Z","updated_at":"2025-03-05T18:59:09.322Z","avatar_url":"https://github.com/CodeWithTejpratab.png","language":"Lua","readme":"# kickstart.nvim\n\n## Introduction\n\nA starting point for Neovim that is:\n\n* Small\n* Single-file\n* Completely Documented\n\n**NOT** a Neovim distribution, but instead a starting point for your configuration.\n\n## Installation\n\n### Install Neovim\n\nKickstart.nvim targets *only* the latest\n['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest\n['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim.\nIf you are experiencing issues, please make sure you have the latest versions.\n\n### Install External Dependencies\n\n\u003e **NOTE**\n\u003e [Backup](#FAQ) your previous configuration (if any exists)\n\nExternal Requirements:\n- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)\n- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)\n- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons\n  - if you have it set `vim.g.have_nerd_font` in `init.lua` to true\n- Language Setup:\n  - If want to write Typescript, you need `npm`\n  - If want to write Golang, you will need `go`\n  - etc.\n\n\u003e **NOTE**\n\u003e See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes\n\u003e and quick install snippets\n\nNeovim's configurations are located under the following paths, depending on your OS:\n\n| OS | PATH |\n| :- | :--- |\n| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |\n| Windows (cmd)| `%userprofile%\\AppData\\Local\\nvim\\` |\n| Windows (powershell)| `$env:USERPROFILE\\AppData\\Local\\nvim\\` |\n\n### Install Kickstart\n\nClone kickstart.nvim:\n\n\u003cdetails\u003e\u003csummary\u003e Linux and Mac \u003c/summary\u003e\n\n```sh\ngit clone https://github.com/nvim-lua/kickstart.nvim.git \"${XDG_CONFIG_HOME:-$HOME/.config}\"/nvim\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003e Windows \u003c/summary\u003e\n\nIf you're using `cmd.exe`:\n\n```\ngit clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\\AppData\\Local\\nvim\\\n```\n\nIf you're using `powershell.exe`\n\n```\ngit clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\\AppData\\Local\\nvim\\\n```\n\n\u003c/details\u003e\n\n### Post Installation\n\nStart Neovim\n\n```sh\nnvim\n```\n\nThat's it! Lazy will install all the plugins you have. Use `:Lazy` to view\ncurrent plugin status.\n\nRead through the `init.lua` file in your configuration folder for more\ninformation about extending and exploring Neovim.\n\n### Getting Started\n\n[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)\n\n### Recommended Steps\n\n[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo\n(so that you have your own copy that you can modify) and then install. You\ncan install it on your machine using the methods above.\n\n\u003e **NOTE**\n\u003e Your fork's url will be something like this: `https://github.com/\u003cyour_github_username\u003e/kickstart.nvim.git`\n\n#### Examples of adding popularly requested plugins\n\nNOTE: You'll need to uncomment the line in the init.lua that turns on loading custom plugins.\n\n\u003cdetails\u003e\n  \u003csummary\u003eAdding autopairs\u003c/summary\u003e\n\nThis will automatically install [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs) and enable it on startup. For more information, see documentation for [lazy.nvim](https://github.com/folke/lazy.nvim).\n\nIn the file: `lua/custom/plugins/autopairs.lua`, add:\n\n```lua\n-- File: lua/custom/plugins/autopairs.lua\n\nreturn {\n  \"windwp/nvim-autopairs\",\n  -- Optional dependency\n  dependencies = { 'hrsh7th/nvim-cmp' },\n  config = function()\n    require(\"nvim-autopairs\").setup {}\n    -- If you want to automatically add `(` after selecting a function or method\n    local cmp_autopairs = require('nvim-autopairs.completion.cmp')\n    local cmp = require('cmp')\n    cmp.event:on(\n      'confirm_done',\n      cmp_autopairs.on_confirm_done()\n    )\n  end,\n}\n```\n\n\u003c/details\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eAdding a file tree plugin\u003c/summary\u003e\n\nThis will install the tree plugin and add the command `:Neotree` for you. For more information, see the documentation at [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim).\n\nIn the file: `lua/custom/plugins/filetree.lua`, add:\n\n```lua\n-- File: lua/custom/plugins/filetree.lua\n\nreturn {\n  \"nvim-neo-tree/neo-tree.nvim\",\n  version = \"*\",\n  dependencies = {\n    \"nvim-lua/plenary.nvim\",\n    \"nvim-tree/nvim-web-devicons\", -- not strictly required, but recommended\n    \"MunifTanjim/nui.nvim\",\n  },\n  config = function ()\n    require('neo-tree').setup {}\n  end,\n}\n```\n\n\u003c/details\u003e\n\n### FAQ\n\n* What should I do if I already have a pre-existing neovim configuration?\n  * You should back it up and then delete all associated files.\n  * This includes your existing init.lua and the neovim files in `~/.local` which can be deleted with `rm -rf ~/.local/share/nvim/`\n* Can I keep my existing configuration in parallel to kickstart?\n  * Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME` to maintain multiple configurations. For example, you can install the kickstart configuration in `~/.config/nvim-kickstart` and create an alias:\n    ```\n    alias nvim-kickstart='NVIM_APPNAME=\"nvim-kickstart\" nvim'\n    ```\n    When you run Neovim using `nvim-kickstart` alias it will use the alternative config directory and the matching local directory `~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim distribution that you would like to try out.\n* What if I want to \"uninstall\" this configuration:\n  * See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information\n* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?\n  * The main purpose of kickstart is to serve as a teaching tool and a reference\n    configuration that someone can easily use to `git clone` as a basis for their own.\n    As you progress in learning Neovim and Lua, you might consider splitting `init.lua`\n    into smaller parts. A fork of kickstart that does this while maintaining the \n    same functionality is available here:\n    * [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)\n  * Discussions on this topic can be found here:\n    * [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)\n    * [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)\n\n### Install Recipes\n\nBelow you can find OS specific install instructions for Neovim and dependencies.\n\nAfter installing all the dependencies continue with the [Install Kickstart](#Install-Kickstart) step.\n\n#### Windows Installation\n\n\u003cdetails\u003e\u003csummary\u003eWindows with Microsoft C++ Build Tools and CMake\u003c/summary\u003e\nInstallation may require installing build tools and updating the run command for `telescope-fzf-native`\n\nSee `telescope-fzf-native` documentation for [more details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation)\n\nThis requires:\n\n- Install CMake and the Microsoft C++ Build Tools on Windows\n\n```lua\n{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release \u0026\u0026 cmake --build build --config Release \u0026\u0026 cmake --install build --prefix build' }\n```\n\u003c/details\u003e\n\u003cdetails\u003e\u003csummary\u003eWindows with gcc/make using chocolatey\u003c/summary\u003e\nAlternatively, one can install gcc and make which don't require changing the config,\nthe easiest way is to use choco:\n\n1. install [chocolatey](https://chocolatey.org/install)\neither follow the instructions on the page or use winget,\nrun in cmd as **admin**:\n```\nwinget install --accept-source-agreements chocolatey.chocolatey\n```\n\n2. install all requirements using choco, exit previous cmd and\nopen a new one so that choco path is set, and run in cmd as **admin**:\n```\nchoco install -y neovim git ripgrep wget fd unzip gzip mingw make\n```\n\u003c/details\u003e\n\u003cdetails\u003e\u003csummary\u003eWSL (Windows Subsystem for Linux)\u003c/summary\u003e\n\n```\nwsl --install\nwsl\nsudo add-apt-repository ppa:neovim-ppa/unstable -y\nsudo apt update\nsudo apt install make gcc ripgrep unzip neovim\n```\n\u003c/details\u003e\n\n#### Linux Install\n\u003cdetails\u003e\u003csummary\u003eUbuntu Install Steps\u003c/summary\u003e\n\n```\nsudo add-apt-repository ppa:neovim-ppa/unstable -y\nsudo apt update\nsudo apt install make gcc ripgrep unzip neovim\n```\n\u003c/details\u003e\n\u003cdetails\u003e\u003csummary\u003eDebian Install Steps\u003c/summary\u003e\n\n```\nsudo apt update\nsudo apt install make gcc ripgrep unzip git\necho \"deb https://deb.debian.org/debian unstable main\" | sudo tee -a /etc/apt/sources.list\nsudo apt update\nsudo apt install -t unstable neovim\n```\n\u003c/details\u003e\n\u003cdetails\u003e\u003csummary\u003eFedora Install Steps\u003c/summary\u003e\n\n```\nsudo dnf install -y gcc make git ripgrep fd-find neovim\n```\n\u003c/details\u003e\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodewithtejpratab%2Fnvim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodewithtejpratab%2Fnvim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodewithtejpratab%2Fnvim/lists"}