Skip to content

docs: add doc for project-specific configurations (.lazy.lua) #133

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add doc for project-specific configurations (.lazy.lua) #133

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/configuration/general.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -565,4 +565,25 @@ vim.api.nvim_create_autocmd({ "BufWritePre" }, {
</TabItem>
</Tabs>

## Project-Specific Settings

You can also load different configurations based on what directory you are in.

Project-specific settings are defined in `<project_root>/.lazy.lua`, where
`<project_root>` is the directory neovim is opened in.

```lua title="<project_root>/.lazy.lua"
-- Project-specific editor settings
-- e.g. vim.opt.tabstop = 4

-- Return is required, even if it's an empty table
return {
-- Project-specific plugin settings
-- See next page for how to configure plugins
}
```

See [@kezhenxu94's blog](https://kezhenxu94.me/blog/lazyvim-project-specific-settings)
for more details.

<!-- general:end -->