GitPedia

User example

An example user configuration with a split up structure

From AstroNvim·Updated May 14, 2026·View on GitHub·
·Archived

A user configuration template for [AstroNvim](https://github.com/AstroNvim/AstroNvim) The project is written primarily in Lua, first published in 2023. Key topics include: astronvim, astrovim, lua, neovim, template.

THIS REPOSITORY IS ARCHIVED, OUTDATED, AND NO LONGER VALID

Please refer to the AstroNvim Documentation for the latest instructions


AstroNvim User Configuration Example

A user configuration template for AstroNvim

🛠️ Installation

Make a backup of your current nvim and shared folder

shell
mv ~/.config/nvim ~/.config/nvim.bak mv ~/.local/share/nvim ~/.local/share/nvim.bak

Clone AstroNvim

shell
git clone https://github.com/AstroNvim/AstroNvim ~/.config/nvim

Create a new user repository from this template

Press the "Use this template" button above to create a new repository to store your user configuration.

You can also just clone this repository directly if you do not want to track your user configuration in GitHub.

Clone the repository

shell
git clone https://github.com/<your_user>/<your_repository> ~/.config/nvim/lua/user

Start Neovim

shell
nvim

Contributors

Showing top 4 contributors by commit count.

View all contributors on GitHub →

This article is auto-generated from AstroNvim/user_example via the GitHub API.Last fetched: 6/24/2026