Skip to content

Commit

Permalink
docs: Remove old lazy loading section from readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kristijanhusak committed Sep 15, 2023
1 parent 4c81018 commit 34f977c
Showing 1 changed file with 3 additions and 21 deletions.
24 changes: 3 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,31 +96,13 @@ call dein#add('nvim-orgmode/orgmode')
```

</details>

<details>
<summary><b>Lazy loading (not recommended)</b></summary>
</br>

Lazy loading via `ft` option works, but not completely. Global mappings are not set because plugin is not initialized on startup.
Above setup has a startup time of somewhere between 1 and 3 ms, so there are not many benefits in lazy loading.
If you want to do it anyway, here's the lazy load setup:
```lua
use {'nvim-treesitter/nvim-treesitter'}
use {'nvim-orgmode/orgmode',
ft = {'org'},
config = function()
require('orgmode').setup{}
end
}
```

</details>

### Setup

Note that this setup is not needed for [lazy.nvim](https://github.com/folke/lazy.nvim)
since instructions above covers full setup

```lua
-- init.lua
-- NOTE: this is not needed for lazy.nvim if above instructions were used

-- Load custom treesitter grammar for org filetype
require('orgmode').setup_ts_grammar()
Expand Down

0 comments on commit 34f977c

Please sign in to comment.