leigh/outline.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
hedy
2023-11-02 22:13:53 +08:00
parent 7e67b4a6fc
commit 93dec0a61c
1 changed files with 34 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
README.md
View File

@@ -1,8 +1,9 @@
# ⚠️ NOTE: THIS IS A FORK # Fork status
This is a fork of the original symbols-outline.nvim which merges some selected This is a fork of the original symbols-outline.nvim which fixes a lot of bugs
PRs from the original repo, plus some other improvements due to personal from the original repo.
preferences.
It also adds many more features listed [below](#features).
It does not attempt to be an up-to-date successor of the original repo, nor does It does not attempt to be an up-to-date successor of the original repo, nor does
it attempt to ensure everyone's use-cases are satisfied by providing an overall it attempt to ensure everyone's use-cases are satisfied by providing an overall
@@ -19,19 +20,40 @@ ability).
I do not merge PRs from the original repo that I don't personally need. I do not merge PRs from the original repo that I don't personally need.
- **DO use this fork if**: - **DO use this fork if**:
- You want to use features available in this fork, which are not included - You want to use to bugfixes included in this fork, including `auto_preview`,
upstream (listed below) and others listed in [fixes](#fixes)
- You MIGHT want some up-to-date fixes to problems (that I also face) but is - You want to use [features](#features) available in this fork, which are not
OK with some things not being looked after well (things I don't personally use) included upstream
- You are OK with some things not being looked after well such as CoC support
(things I don't personally use)
- **Do NOT use this fork if**: - **Do NOT use this fork if**:
- You want a stable plugin - You want a stable plugin
- You don't need the extra features in this fork - You don't need the extra features in this fork
- You do not need the bugfixes in this fork
## Fixes
- Symbol preview empty (simrat39/symbols-outline.nvim#176)
- `SymbolsOutlineClose` crashing when already closed: simrat39/symbols-outline.nvim#163
- Symbols not showing by supporting Nerd fonts v3.0: simrat39/symbols-outline.nvim#225
- Newlines in symbols crash: simrat39/symbols-outline.nvim#204 (simrat39/symbols-outline.nvim#184)
- `code_actions`: simrat39/symbols-outline.nvim#168 (simrat39/symbols-outline.nvim#123)
- Fold all operation too slow: simrat39/symbols-outline.nvim#223 (simrat39/symbols-outline.nvim#224)
- "Invalid buffer id" error simrat39/symbols-outline.nvim#177
- Open handler triggering multiple times ends up in messy state with errors
simrat39/symbols-outline.nvim#235
## 🛑 Breaking changes ## 🛑 Breaking changes
- **Config**: `keymaps.focus_location` -> `keymaps.peek_location` to avoid This section may be relevant to you if your existing config uses the mentioned
confusion with focus window commands. features:
- **Config**: `keymaps.focus_location` RENAMED to `keymaps.peek_location` to
avoid confusion with focus window commands.
- **Config**: Marker icons used for guides can now be customized. `show_guides`
REMOVED in favor of `guides.enabled`.
- **Behaviour**: Removed hover floating window from `toggle_preview`. - **Behaviour**: Removed hover floating window from `toggle_preview`.
- Instead, you can set `open_hover_on_preview=true` (true by default) so that - Instead, you can set `open_hover_on_preview=true` (true by default) so that
@@ -42,9 +64,6 @@ I do not merge PRs from the original repo that I don't personally need.
- The preview window is positioned to be vertically center-aligned (rather - The preview window is positioned to be vertically center-aligned (rather
than fixed to the top). This is planned to be configurable. than fixed to the top). This is planned to be configurable.
- **Config**: Marker icons used for guides can now be customized. `show_guides`
removed in favor of `guides.enabled`.
- **Behaviour**: When `auto_close=true` only auto close if `goto_location` is - **Behaviour**: When `auto_close=true` only auto close if `goto_location` is
used (where focus changed), and not for `focus_location` used (where focus changed), and not for `focus_location`
(simrat39/symbols-outline.nvim#119). (simrat39/symbols-outline.nvim#119).
@@ -80,18 +99,6 @@ Features/Changes:
- Flash highlight when using goto/peek location. - Flash highlight when using goto/peek location.
## Fixes
- Symbol preview (simrat39/symbols-outline.nvim#176)
- `SymbolsOutlineClose` crashing when already closed: simrat39/symbols-outline.nvim#163
- Symbols not showing by supporting Nerd fonts v3.0: simrat39/symbols-outline.nvim#225
- Newlines in symbols crash: simrat39/symbols-outline.nvim#204 (simrat39/symbols-outline.nvim#184)
- `code_actions`: simrat39/symbols-outline.nvim#168 (simrat39/symbols-outline.nvim#123)
- Fold all operation too slow: simrat39/symbols-outline.nvim#223 (simrat39/symbols-outline.nvim#224)
- "Invalid buffer id" error simrat39/symbols-outline.nvim#177
- Open handler triggering multiple times ends up in messy state with errors
simrat39/symbols-outline.nvim#235
## PRs ## PRs
Key: Key:
@@ -203,6 +210,8 @@ Items will be moved to above list when complete.
- nvim-navbuddy - nvim-navbuddy
- dropdown.nvim - dropdown.nvim
- treesitter (inspect/edit) - treesitter (inspect/edit)
- lspsaga
- navigator.lua
--- ---