reorder readme sections
This commit is contained in:
parent
87ea788dee
commit
f178b292f8
82
README.md
82
README.md
|
|
@ -2,47 +2,6 @@
|
||||||
|
|
||||||
Living reference for session management, keymaps, commands, and plugin-specific features in this config.
|
Living reference for session management, keymaps, commands, and plugin-specific features in this config.
|
||||||
|
|
||||||
## Configuration Options
|
|
||||||
|
|
||||||
### Tabline Display
|
|
||||||
|
|
||||||
Custom tabline shows intelligent path shortening with two configurable options.
|
|
||||||
|
|
||||||
**Location:** `lua/settings.lua` (configured via `utils.tabline_full_parents` and `utils.tabline_shorten_length`)
|
|
||||||
|
|
||||||
**Configuration Options:**
|
|
||||||
|
|
||||||
1. **`utils.tabline_full_parents`** (default: `1`) - Number of parent directories to show in full
|
|
||||||
2. **`utils.tabline_shorten_length`** (default: `3`) - Number of characters to show for shortened directories
|
|
||||||
|
|
||||||
**Examples:**
|
|
||||||
|
|
||||||
With `full_parents = 1, shorten_length = 3`:
|
|
||||||
- `/path/to/my/project/src/file.txt` → `pat/to/my/project/src/file.txt`
|
|
||||||
|
|
||||||
With `full_parents = 2, shorten_length = 3`:
|
|
||||||
- `/path/to/my/project/src/file.txt` → `pat/to/my/project/src/file.txt`
|
|
||||||
|
|
||||||
With `full_parents = 1, shorten_length = 1`:
|
|
||||||
- `/path/to/my/project/src/file.txt` → `p/t/m/project/src/file.txt`
|
|
||||||
|
|
||||||
With `full_parents = 0, shorten_length = 3`:
|
|
||||||
- `/path/to/my/project/src/file.txt` → `pat/to/my/pro/src/file.txt`
|
|
||||||
|
|
||||||
The last N parent directories are shown in full, earlier directories are shortened to the specified number of characters. The filename itself is always shown in full.
|
|
||||||
|
|
||||||
**To customize:** Edit `utils.tabline_full_parents` and `utils.tabline_shorten_length` values in `lua/settings.lua`
|
|
||||||
|
|
||||||
## Working Directory Behavior
|
|
||||||
|
|
||||||
The working directory (`:pwd`) is locked to the directory where you opened Neovim and does NOT change when switching files:
|
|
||||||
|
|
||||||
- `autochdir` is disabled (working directory stays fixed at project root)
|
|
||||||
- `netrw_keepdir = 1` prevents netrw from changing directory when browsing
|
|
||||||
- Project root is captured at startup in `vim.g.project_root` (used by Telescope and netrw)
|
|
||||||
- Telescope searches from the initial project root regardless of current buffer
|
|
||||||
- Use `:cd <path>` to manually change directory if needed (affects Telescope search scope)
|
|
||||||
|
|
||||||
## Session Management
|
## Session Management
|
||||||
|
|
||||||
Session support is automatic but user-controlled:
|
Session support is automatic but user-controlled:
|
||||||
|
|
@ -500,3 +459,44 @@ Both `phpcs` and `phpcbf` will now use PSR-12 rules in that project.
|
||||||
- **Automatic**: Runs on `BufEnter`, `BufWritePost`, `InsertLeave`
|
- **Automatic**: Runs on `BufEnter`, `BufWritePost`, `InsertLeave`
|
||||||
- **Per-filetype**: Configured in `lint.linters_by_ft` table
|
- **Per-filetype**: Configured in `lint.linters_by_ft` table
|
||||||
- **Markdown**: Opt-in only (`:MarkdownLintEnable` / `:MarkdownLintDisable`)
|
- **Markdown**: Opt-in only (`:MarkdownLintEnable` / `:MarkdownLintDisable`)
|
||||||
|
|
||||||
|
## Configuration Options
|
||||||
|
|
||||||
|
### Tabline Display
|
||||||
|
|
||||||
|
Custom tabline shows intelligent path shortening with two configurable options.
|
||||||
|
|
||||||
|
**Location:** `lua/settings.lua` (configured via `utils.tabline_full_parents` and `utils.tabline_shorten_length`)
|
||||||
|
|
||||||
|
**Configuration Options:**
|
||||||
|
|
||||||
|
1. **`utils.tabline_full_parents`** (default: `1`) - Number of parent directories to show in full
|
||||||
|
2. **`utils.tabline_shorten_length`** (default: `3`) - Number of characters to show for shortened directories
|
||||||
|
|
||||||
|
**Examples:**
|
||||||
|
|
||||||
|
With `full_parents = 1, shorten_length = 3`:
|
||||||
|
- `/path/to/my/project/src/file.txt` → `pat/to/my/project/src/file.txt`
|
||||||
|
|
||||||
|
With `full_parents = 2, shorten_length = 3`:
|
||||||
|
- `/path/to/my/project/src/file.txt` → `pat/to/my/project/src/file.txt`
|
||||||
|
|
||||||
|
With `full_parents = 1, shorten_length = 1`:
|
||||||
|
- `/path/to/my/project/src/file.txt` → `p/t/m/project/src/file.txt`
|
||||||
|
|
||||||
|
With `full_parents = 0, shorten_length = 3`:
|
||||||
|
- `/path/to/my/project/src/file.txt` → `pat/to/my/pro/src/file.txt`
|
||||||
|
|
||||||
|
The last N parent directories are shown in full, earlier directories are shortened to the specified number of characters. The filename itself is always shown in full.
|
||||||
|
|
||||||
|
**To customize:** Edit `utils.tabline_full_parents` and `utils.tabline_shorten_length` values in `lua/settings.lua`
|
||||||
|
|
||||||
|
## Working Directory Behavior
|
||||||
|
|
||||||
|
The working directory (`:pwd`) is locked to the directory where you opened Neovim and does NOT change when switching files:
|
||||||
|
|
||||||
|
- `autochdir` is disabled (working directory stays fixed at project root)
|
||||||
|
- `netrw_keepdir = 1` prevents netrw from changing directory when browsing
|
||||||
|
- Project root is captured at startup in `vim.g.project_root` (used by Telescope and netrw)
|
||||||
|
- Telescope searches from the initial project root regardless of current buffer
|
||||||
|
- Use `:cd <path>` to manually change directory if needed (affects Telescope search scope)
|
||||||
Loading…
Reference in New Issue