Skip to content

Commit 159db45

Browse files
Add concealing instructions to troubleshoot section.
1 parent 8e3edfa commit 159db45

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -201,17 +201,17 @@ Highlights are experimental and partially supported.
201201
* Headline markup highlighting (https://github.com/nvim-orgmode/orgmode/issues/67)
202202

203203
#### Troubleshoot
204-
**Folding is not working**<br />
204+
##### Folding is not working
205205
Make sure you are not overriding foldexpr in Org buffers with [nvim-treesitter folding](https://github.com/nvim-treesitter/nvim-treesitter#folding)
206206

207-
**Indentation is not working**<br />
207+
##### Indentation is not working
208208
Make sure you are not overriding indentexpr in Org buffers with [nvim-treesitter indentation](https://github.com/nvim-treesitter/nvim-treesitter#indentation)
209209

210-
**I get `treesitter/query.lua` errors when opening agenda/capture prompt or org files**<br />
210+
##### I get `treesitter/query.lua` errors when opening agenda/capture prompt or org files
211211
Make sure you are using latest changes from [tree-sitter-org](https://github.com/milisims/tree-sitter-org) grammar.<br />
212212
by running `:TSUpdate org` and restarting the editor.
213213

214-
**Dates are not in English**<br />
214+
##### Dates are not in English
215215
Dates are generated with Lua native date support, and it reads your current locale when creating them.<br />
216216
To use different locale you can add this to your `init.lua`:
217217
```lua
@@ -224,6 +224,20 @@ language en_US.utf8
224224
Just make sure you have `en_US` locale installed on your system. To see what you have available on the system you can
225225
start the command `:language ` and press `<TAB>` to autocomplete possible options.
226226

227+
##### Links are not concealed
228+
Links are concealed with Vim's conceal feature (see `:help conceal`). To enable concealing, add this to your `init.lua`:
229+
```lua
230+
vim.opt.conceallevel = 2
231+
vim.opt.concealcursor = 'nc'
232+
```
233+
234+
Or if you are using `init.vim`:
235+
236+
```vim
237+
set conceallevel=2
238+
set concealcursor=nc
239+
```
240+
227241
### Features (TL;DR):
228242
* Agenda view
229243
* Search by tags/keyword

0 commit comments

Comments
 (0)