KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #codex #claude-code #mcp #rust #deepseek-harness #typescript #ai-agent #cli

one.nvim

★ 187 Open GitHub ↗

All-in-one neovim config framework in Lua.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# One.nvim

All-in-one neovim configuration framework implemented with Lua. It is highly flexible to be customized and extended.

[English](./README.md) | [中文](./README.zh.md)

## Features

- All in Lua. All configs can be overridden. Read [Configuration](#configuration).
- Use many Neovim features: Native LSP, Float Window, Winbar.
- Supporting plugin manager: [lazy.nvim][]
- Awesome UI and color schema. Dark Mode. Support True-Color, Smooth-Scroll, Scrollbar, Dashboard. You can change colors and highlights. Read [Colors and Highlights](./doc/colors.md).
- Configurable proxy for fast git download in China Mainland. Read [Proxy](./doc/usage/proxy.md).
- Integrated 130+ powerful Vim/Nvim plugins. Enhancing the usage experience, and fixed some shortcomings of these plugins.

<details close>
<summary>Click to expend/collapse plugin list</summary>

- Plugin Manager: [lazy.nvim](lua/one/plugin-manager/lazy.lua) (default)
  - AI: [avante.nvim](lua/one/plugins/ai/avante.lua) and [mcphub.nvim](lua/one/plugins/ai/mcphub.lua)
  - Vim Options: [vim-options](lua/one/plugins/vim-options.lua)
  - Utilities: [plenary](https://github.com/nvim-lua/plenary.nvim) and [Penlight](https://github.com/lunarmodules/Penlight) and [nui](https://github.com/MunifTanjim/nui.nvim)
  - Dashboard: [alpha.nvim](lua/one/plugins/alpha.lua)
  - Outline: [aerial](lua/one/plugins/aerial.lua) (default) or [majutsushi/tagbar](lua/one/plugins/tagbar.lua)
  - File Explorer: [neo-tree](lua/one/plugins/neo-tree.lua) (default) or [nerdtree](lua/one/plugins/nerdtree.lua) or [nvim-tree](lua/one/plugins/nvim-tree.lua)
  - Statusline: [lualine](lua/one/plugins/lualine.lua) (default) or [airline](lua/one/plugins/airline.lua)
  - Tabline: [tabby](lua/one/plugins/tabby.lua)
  - Bufferline: [barbar](lua/one/plugins/barbar.lua) or [bufferline](lua/one/plugins/bufferline.lua) (If use bufferline, you should disable tabline plugin)
  - Cursorline Highlight: [beacon](lua/one/plugins/beacon.lua) (default) or [specs.nvim](lua/one/plugins/specs.lua)
  - Scrollbar: [nvim-scrollbar](lua/one/plugins/scrollbar.lua)
  - Smooth-Scroll: [neoscroll.nvim](lua/one/plugins/scroll.lua)
  - Session: [persisted](lua/one/plugins/session/persisted.lua) (default) or [possession](lua/one/plugins/session/possession.lua) or [xolox/vim-session](lua/one/plugins/session/vim-session.lua) or [rmagatti/auto-session](lua/one/plugins/session/auto-session.lua)
  - Fuzzy Finding: [telescope](lua/one/plugins/telescope/main.lua) and [ctrlsf](lua/one/plugins/search/ctrlsf.lua)
  - Diagnostics Window: [trouble](lua/one/plugins/trouble.lua)
  - Undo: [vim-mundo](lua/one/plugins/undotree.lua)
  - Syntax Highlight: [treesitter][] and [nvim-ts-rainbow](lua/one/plugins/treesitter/rainbow.lua)
  - Highlight Words: [vim-interestingwords](lua/one/plugins/highlight-words.lua)
  - Code Comment: [Comment.nvim](lua/one/plugins/comment.lua) (default) or [nerdcommenter](lua/one/plugins/comment_nerd.lua)
  - LSP: [nvim-lspconfig](lua/one/plugins/lsp/main.lua) and [treesitter](lua/one/plugins/treesitter/init.lua) and [none-ls](lua/one/plugins/lsp/none-ls.lua) and [nlsp](lua/one/plugins/lsp/nlsp.lua) and [goto-preview](lua/one/plugins/lsp/preview.lua) and [lsp-toggle](https://github.com/adoyle-h/lsp-toggle.nvim)
  - DAP: [nvim-dap](lua/one/plugins/dap/init.lua)
  - Format: [conform.nvim](./lua/one/plugins/format/conform.lua) and [editorconfig-vim](https://github.com/editorconfig/editorconfig-vim)
  - Formatter, Linter, LSP, DAP Manager: [mason](lua/one/plugins/lsp/mason.lua) and [mason-installer](lua/one/plugins/lsp/mason-installer.lua)
  - Completion: [nvim-cmp](lua/one/plugins/completion/init.lua)
  - Snippets: [nvim-snippy](lua/one/plugins/completion/snippet.lua)
  - Markdown: [render-markdown.nvim](lua/one/plugins/markdown/main.lua) and [markdown-preview](lua/one/plugins/markdown/preview.lua) and [vim-MarkdownTOC](lua/one/plugins/markdown/toc.lua)
  - Surrounds: [nvim-surround](lua/one/plugins/match/surround/init.lua) and [nvim-autopairs](lua/one/plugins/match/autopairs.lua) and [nvim-ts-autotag](lua/one/plugins/match/ts-autotag.lua) and [vim-matchup](lua/one/plugins/match/matchup.lua)
  - Git: [gitsigns](lua/one/plugins/git/sign.lua) and [lazygit](lua/one/plugins/git/lazygit.lua) and [diffview.nvim](https://github.com/sindrets/diffview.nvim)
  - Indent Line: [indent-blankline](lua/one/plugins/indent-line.lua)
  - Cursor Move: [flash.nvim](lua/one/plugins/move/flash.lua) and [accelerated-jk](lua/one/plugins/move/accelerated.lua) or [hop.nvim](lua/one/plugins/move/jump.lua)
  - Window Picker: [nvim-window-picker](lua/one/plugins/move/window-picker.lua) or [vim-choosewin](lua/one/plugins/move/choose-window.lua)
  - Window Resize: [simeji/winresizer](lua/one/plugins/window/resize.lua) and [windows.nvim](lua/one/plugins/window/maximize.lua)
  - Context: [aerial](lua/one/plugins/aerial.lua) (default) or [navic](lua/one/plugins/navic.lua) and [nvim-treesitter-context](lua/one/plugins/treesitter/context.lua)
  - Text Align: [vim-easy-align](lua/one/plugins/align.lua)
  - Bookmark: [vim-bookmarks](lua/one/plugins/bookmark.lua)
  - Mark: [marks.nvim](lua/one/plugins/mark.lua)
  - Calendar: [mattn/calendar-vim](lua/one/plugins/calendar.lua)
  - Curl: [rest.nvim](lua/one/plugins/curl.lua)
  - Icons: [devicons](lua/one/plugins/devicons.lua) and [icon-picker](lua/one/plugins/icon-picker.lua)
  - UI Enhancing: [dressing](lua/one/plugins/dressing.lua) and [noice](lua/one/plugins/noice.lua)
  - Escape: [better-escape.nvim](lua/one/plugins/escape.lua)
  - Increment: [increment-activator](lua/one/plugins/increment.lua)
  - Filetype: [filetype.nvim](lua/one/plugins/filetype.lua)
  - Latex: [nabla](lua/one/plugins/latex.lua)
  - Notification: [notify](lua/one/plugins/notify.lua) (default) or [notifier](lua/one/plugins/notifier.lua)
  - Profiling: [vim-startuptime](lua/one/plugins/profiling.lua)
  - Text-Objects: [wildfire](lua/one/plugins/select.lua) and [nvim-treesitter-textobjects](https://github.com/nvim-treesitter/nvim-treesitter-textobjects)
  - Table Edit: [vim-table-mode](lua/one/plugins/table.lua)
  - Terminal: [neoterm](lua/one/plugins/terminal/neoterm.lua)
  - Testing: [nvim-test](lua/one/plugins/test.lua)
  - TODO Comment: [todo-comments](lua/one/plugins/todo.lua)
  - Trailing Spaces: [whitespace](lua/one/plugins/trailing.lua)
  - Yank: [yanky](lua/one/plugins/yank.lua)
  - Zen Mode: [twilight and zen-mode](lua/one/plugins/zen.lua)
  - Notebook: [zk](lua/one/plugins/zk.lua)
  - Live Command: [live-command](https://github.com/smjonas/live-command.nvim)
  - Color Highlighter: [ccc.nvim](lua/one/plugins/colors/ccc.lua) (default) or [vim-hexokinase](lua/one/plugins/colors/hexokinase.lua) or [nvim-colorizer](lua/one/plugins/colors/colorizer.lua)
  - Translation: [translate.nvim](lua/one/plugins/translate.lua)
  - [Games](lua/one/plugins/funny.lua)
  - one.nvim enhanced plugin: [one](lua/one/plugins/one.lua)

</details>

## Screenshots

<details open>
<summary>Click to expend/collapse</summary>

### Dashboard

![dashboard.png](https://media.githubusercontent.com/media/adoyle-h/_imgs/master/github/one.nvim/dashboard.png)

### UI

![UI.png](https://media.githubusercontent.com/media/adoyle-h/_imgs/master/github/one.nvim/UI.png)

![UI-2.png](https://media.githubusercontent.com/media/adoyle-h/_imgs/master/github/one.nvim/UI-2.png)

![Markdown UI](https://raw.githubusercontent.com/adoyle-h/_imgs/master/github/one.nvim/markdown-ui.webp)

### Hidden cmdline

![UI-noice.png](https://media.githubusercontent.com/media/adoyle-h/_imgs/master/github/one.nvim/UI-noice.png)

If you don't like the hidden cmdline, you can disable noice.nvim plugin to get the classic UI. Follow this config:

```lua
require('one').setup { plugins = { 'noice', disable = true } }
```

### Outline

![outline.png](https://media.githubusercontent.com/media/adoyle-h/_imgs/master/github/one.nvim/outline.png)

Press `<space>o` to open the outline.

### File Finder

![finder.png](https://media.githubusercontent.com/media/adoyle-h/_imgs/master/github/one.nvim/finder.png)

Press `<space>f` to open the file finder.

### Keymaps

![keymaps.png](https://media.githubusercontent.com/media/adoyle-h/_imgs/master/github/one.nvim/keymaps.png)

Press `<space>k` to open the keymap finder.

### Command Finder

![cmd-finder.png](https://media.githubusercontent.com/media/adoyle-h/_imgs/master/github/one.nvim/cmd-finder.png)

Press `<space>p` to open the keymap finder.

### Diagnostic

![diagnostic.png](https://media.githubusercontent.com/media/adoyle-h/_imgs/master/github/one.nvim/diagnostic.png)

Press `<space>d` or `<space>D` to open the diagnostic list. See [Diagnostic keymaps](./doc/usage/keymaps.md#diagnostic).

### Completion

![completion.png](https://media.githubusercontent.com/media/adoyle-h/_imgs/master/github/one.nvim/completion.png)

Function signature completion

![completion-function-args.png](https://media.githubusercontent.com/media/adoyle-h/_imgs/master/github/one.nvim/completion-function-args.png)

</details>

## [Installation](./doc/install-and-init.md)

## Update

You can update the one.nvim via plugin manager or commands `:OneUpdate one` or `:lua one.update('one')`.

Please submit [issue][] when encounter problems after updating.

## [FAQ](./doc/faq/README.md)

## [Notice](./doc/note.md)

## Configuration

```lua
require('one').setup {}
```

All config options are optional. You can override default configs.
Please read [User Config](./doc/user-config.md).

## Plugin Manager

**Note**: One.nvim use [lazy.nvim](https://github.com/folke/lazy.nvim) as plugin manager. The lazy.nvim would be installed on start up. So user should not install one.nvim via plugin manager.

|                   | lazy.nvim               |
|-------------------|-------------------------|
| Plugins Directory | {DATA_DIR}/plugins      |
| Default Config    | lua/one/config/lazy.lua |

The value of `{DATA_DIR}` is `:lua print(vim.fn.stdpath('data'))`.

```lua
require('one').setup {
  config = {
    pluginManager = { use = 'lazy' }, -- Default to 'lazy'. Available value: lazy' or 'local'
  },
}
```

When `config.pluginManager.use = 'local'`, this plugin manager can only load local plugins. It cannnot install packages from remote.

## Plugin

All plugins can be turned off, overridden default config options, replaced with your favorites.
It is highly flexible to be customized and extended.

Read [./doc/plugin.md](./doc/plugin.md) for plugin definitions and references.

You can even set `onlyPlugins = {}` to disable all plugins. Read [Debug - Disable other plugins](./doc/usage/debug.md#disable-other-plugins).

You can invoke `:OneShowPlugins` to view disabled and enabled plugins.

## [Usage](./doc/usage/README.md)

- [Debug](./doc/usage/debug.md)
- [Keymaps](./doc/usage/keymaps.md)
- [Commands](./doc/usage/commands.md)
- [Colors and Highlights](./doc/colors.md)
- [Snippets](./doc/usage/snippet.md)
- [LSP](./doc/usage/README.md#lsp)
- [Code Format](./doc/usage/README.md#code-format)
- [Telescope Extensions](./doc/usage/README.md#telescope-extensions)
- [Window Picker](./doc/usage/README.md#window-picker)
- [Float Cmdline](./doc/usage/README.md#float-cmdline)
- [Unloaded Plugins](./doc/usage/README.md#unloaded-plugins)
- [Extend your plugins/highlights/commands and so on](./doc/usage/README.md#extend-your-pluginshighlightscommands-and-so-on)
- [Global Variable](./doc/usage/README.md#global-variable)
- [Startup Time](./doc/usage/README.md#startup-time)
- [Proxy](./doc/usage/proxy.md)

## API

Just read [codes](./lua/one/init.lua).

## Project File Structure

```
.
├── doc/                     // Documents
├── lua/
│   └── one/
│       ├── async.lua        // async library
│       ├── config/          // Keymaps
│       │   ├── colors.lua   // Default color config
│       │   ├── default.lua  // Default config
│       │   ├── lazy.lua     // Default config for lazy.nvim
│       │   └── symbol.lua   // symbols
│       ├── config.lua       // Config loader
│       ├── consts.lua       // Constants
│       ├── filetype.lua     // FileType autocmd
│       ├── one.lua          // The one singleton
│       ├── init.lua         // The lua required entry point
│       ├── plugins.lua      // Plugin loading list
│       ├── util.lua         // Utility functions
│       ├── util_spec.lua    // Unit test for util.lua
│       ├── keymap/          // Keymaps
│       ├── plugins/         // Available plugins written in lua
│       │   └── themes/      // Color schemas
│       └── plugin-manager/
│           ├── init.lua     // Plugin Manager
│           ├── lazy.lua     // Wrapper for lazy.nvim
│           └── local.lua    // Only load local files
└── scripts/                 // scripts for building project
```

## Suggestion, Bug Reporting, Contributing

**Before opening new Issue/Discussion/PR and posting any comments**, please read [./CONTRIBUTING.md](./CONTRIBUTING.md).

## Copyright and License

Copyright 2016-2026 ADoyle (adoyle.h@gmail.com). Some Rights Reserved.
The project is licensed under the **BSD 3-clause License**.

Read the [LICENSE][] file for the specific language governing permissions and limitations under the License.

Read the [NOTICE][] file distributed with this work for additional information regarding copyright ownership.

## Other Projects

[Other nvim projects](https://github.com/adoyle-h?tab=repositories&q=&type=source&language=lua&sort=stargazers) created by me.

[LICENSE]: ./LICENSE
[NOTICE]: ./NOTICE
[packer.nvim]: https://github.com/wbthomason/packer.nvim
[treesitter]: https://github.com/nvim-treesitter/nvim-treesitter
[lazy.nvim]: https://github.com/folke/lazy.nvim
[issue]: https://github.com/adoyle-h/one.nvim/issues

one.nvim

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README