austere.nvim ☠️

Austere is a minimally constructed neovim config built from the ground up. https://github.com/refcell/austere.nvim/labels/beta

📄 Overview

At its core, Austere is an opinionated neovim configuration with remote usage as a core design tennant. Austere is not meant to be a framework and provides an implementation rich codebase that should be modified directly to extend components and add features.

Non-extensibility is intentional. Not supporting extensible usage acts as a forcing function to upstream modifications directly to Austere. This way, Austere is maintained and constantly improved by its users.

Finally, performance is a priority without sacrificing aesthetic. If you see a way to improve Austere while following this requirement, contribute!.

📦 Usage

To use Austere, clone the repo and then install the configuration.

Note

just must be installed to use the convenience bash Justfile target commands.

git clone https://github.com/refcell/austere.nvim
cd austere.nvim
just backup-and-install

This will copy the Austere config into the ~/.config/nvim/ directory. If a neovim config already exists in this directory, it will be copied in a backup directory ~/.config/nvim.bak. If you need to revert the Austere installation, you can simply run just restore-backup.

⚡️ Requirements

Neovim >= 0.8.0 (needs to be built with LuaJIT)
Git >= 2.19.0 (for partial clones support)
ripgrep is used for fast, efficient live word greps.
lazygit for a clean git ui
A Nerd Font (optional)

✨ Features & Keybindings

Note

The leader key is configured in mappings.lua to the space key.

lazy.nvim

The lazy plugin manager provides a robust, standardized way to manage neovim plugins. It provides profiling metrics, lazy loading and cache optimizations for plugin loading, a clean ui, and much more.

Keybindings

ctrl + p (or leader + p): Pull up Lazy profiling.

Lazy Git

Bufferline

Verbose Status Line

Austere uses lualine to

Hot Theme Toggling

<leader>t toggles inverse light or dark background, causing the colorscheme to alternate between the mocha and slightly modified latte catppuccin themes.

⚙️ Architecture

init.lua acts as the entrypoint for the neovim config. It performs a few key operations that is responsible for loading neovim.

🔌 Plugins

folke/lazy.nvim: Lazy Plugin Manager
goolord/alpha-nvim: Startup dashboard
nvim-neo-tree/neo-tree: File system browser
akinsho/bufferline.nvim: Top buffer line
numToStr/Comment.nvim: Comment lines with keybindings
nvim-lualine/lualine.nvim: Bottom status line
williamboman/mason.nvim: Mason package manager
folke/neoconf.nvim: Neovim config manager
folke/neodev.nvim: Convenience methods for neovim development
folke/noice.nvim: Messages, cmdline, popup ui
backdround/global-note.nvim: Simple Global notepad
zbirenbaum/copilot.lua: Github Copilot plugin
kevinhwang91/promise-async: Dependency
tiagovla/scope.nvim: Scopes block codes for collapse and expansion
mrjones2014/smart-splits.nvim: Manage buffer and tab splits
backdround/tabscope.nvim: Tab scoping
nvim-telescope/telescope.nvim: Ergonomic search menu
akinsho/toggleterm.nvim: Popup terminal
catppuccin/nvim: Catppuccin theme
nvim-treesitter/nvim-treesitter: Neovim treesitter syntax highlighting
kevinhwang91/nvim-ufo: Modern neovim folding
folke/which-key.nvim: Available keybinding popup menu

🐛 Contributing

All contributions are welcome!

When contributing please provide a concise description of the issue, feature request, or your changes.

🔒 License

Open sourced under the MIT License.

h3lio5 / austere.nvim Goto Github PK

austere.nvim's Introduction