Skip to content

Commit

Permalink
Undo readme formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
squk committed Nov 25, 2024
1 parent 33e7ee6 commit 57ef1d2
Showing 1 changed file with 12 additions and 23 deletions.
35 changes: 12 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
This plugin automatically disables certain features if the opened file is big.
File size and features to disable are configurable.

Features/integrations include: `LSP`, `treesitter`, `indent_blankline`,
`illuminate.vim` `NoMatchParen`, `syntax off`, ... (full list at the end)
Features/integrations include: `LSP`, `treesitter`, `indent_blankline`, `illuminate.vim` `NoMatchParen`, `syntax off`, ... (full list at the end)

You can also add your own features.

Expand All @@ -31,7 +30,6 @@ require("bigfile").setup {
features = { -- features to disable
"indent_blankline",
"illuminate",
"cmp",
"lsp",
"treesitter",
"syntax",
Expand Down Expand Up @@ -89,26 +87,17 @@ require("bigfile").setup {

# Caveats

- `matchparen` stays disabled, even after you close the big file, you can call
`:DoMatchParen` manually to enable it
- `matchparen` stays disabled, even after you close the big file, you can call `:DoMatchParen` manually to enable it

# Features/integrations

| name | function |
| ------------------ | ------------------------------------- |
| `lsp` | detaches the lsp client from buffer |
| `treesitter` | disables treesitter for the buffer |
| `illuminate` | disables `RRethy/vim-illuminate` for |
: : the buffer :
| `indent_blankline` | disables |
: : `lukas-reineke/indent-blankline.nvim` :
: : for the buffer :
| `syntax` | `:syntax off` for the buffer |
| `filetype` | `filetype = ""` for the buffer |
| `vimopts` | `swapfile = false` `foldmethod = |
: : "manual"` `undolevels = -1` :
: : `undoreload = 0` `list = false` for :
: : the buffer :
| `matchparen` | `:NoMatchParen` globally, currently |
: : this feature will stay disabled, even :
: : after you close the big file :
| name | function |
| ------------------ | ----------------------------------------------------------------------------------------------------------- |
| `lsp` | detaches the lsp client from buffer |
| `treesitter` | disables treesitter for the buffer |
| `illuminate` | disables `RRethy/vim-illuminate` for the buffer |
| `indent_blankline` | disables `lukas-reineke/indent-blankline.nvim` for the buffer |
| `syntax` | `:syntax off` for the buffer |
| `filetype` | `filetype = ""` for the buffer |
| `vimopts` | `swapfile = false` `foldmethod = "manual"` `undolevels = -1` `undoreload = 0` `list = false` for the buffer |
| `matchparen` | `:NoMatchParen` globally, currently this feature will stay disabled, even after you close the big file |

0 comments on commit 57ef1d2

Please sign in to comment.