Skip to content

Commit ab24c84

Browse files
authored
Links for README.org + increase timeout for load_sync (#782)
* docs(README): add custom_ids and fix relative links In nvim-orgmode, you can point to a headline either by using the star syntax (* HEADLINE) or by using a custom-id in the properties drawer of the headline, and then refer to it using the hash syntax (#custom-id). This commit adds custom_ids for all the headlines referred to into the README.org file and fixes relative links to other files in the repository. * fix(init): increment the default timeout to 15 seconds On slow devices (for example Android smartphones using Termux), loading a lot of org files takes more than 5 seconds, which will make the default timeout for the promise to expire, leaving the plugin in a semi-loaded state where some functionalities may not work, forcing the user to reload the plugin multiple times hoping that the system has something already cached and it will take less than 5 seconds.
1 parent 60f29c3 commit ab24c84

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

README.org

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
Orgmode clone written in Lua for Neovim 0.9.4+
1212

13-
[[#setup][Setup]] • [[/DOCS.md][Docs]] • [[#showcase][Showcase]] • [[#treesitter-info][Treesitter]] • [[#troubleshoot][Troubleshoot]] • [[#plugins][Plugins]] • [[CONTRIBUTING.md][Contributing]] • [[#thanks-to][Kudos]]
13+
[[#setup][Setup]] • [[file:./DOCS.md][Docs]] • [[#showcase][Showcase]] • [[#treesitter-info][Treesitter]] • [[#troubleshoot][Troubleshoot]] • [[#plugins][Plugins]] • [[file:./CONTRIBUTING.md][Contributing]] • [[#thanks-to][Kudos]]
1414

1515
#+HTML:</div>
1616

@@ -79,6 +79,9 @@ call dein#add('nvim-orgmode/orgmode')
7979
#+HTML:</details>
8080

8181
*** Setup
82+
:PROPERTIES:
83+
:CUSTOM_ID: setup
84+
:END:
8285

8386
Note that this setup is not needed for [[https://github.com/folke/lazy.nvim][lazy.nvim]]
8487
since instructions above covers full setup
@@ -150,6 +153,9 @@ If you are new to Orgmode, see [[/DOCS.md#getting-started-with-orgmode][Getting
150153
or a hands-on [[https://github.com/nvim-orgmode/orgmode/wiki/Getting-Started][tutorial]] in our wiki.
151154

152155
** Showcase
156+
:PROPERTIES:
157+
:CUSTOM_ID: showcase
158+
:END:
153159

154160
*** Agenda
155161

@@ -176,6 +182,9 @@ or a hands-on [[https://github.com/nvim-orgmode/orgmode/wiki/Getting-Started][tu
176182
[[https://user-images.githubusercontent.com/1782860/123550227-e8605800-d76c-11eb-96f6-c0a677d562d4.gif]]
177183

178184
** Treesitter Info
185+
:PROPERTIES:
186+
:CUSTOM_ID: treesitter-info
187+
:END:
179188

180189
The built-in treesitter parser is used for parsing the org files.
181190

@@ -184,6 +193,9 @@ The built-in treesitter parser is used for parsing the org files.
184193
- LaTex is still highlighted through syntax file
185194

186195
** Troubleshoot
196+
:PROPERTIES:
197+
:CUSTOM_ID: troubleshoot
198+
:END:
187199

188200
*** Indentation is not working
189201

@@ -329,6 +341,9 @@ More info on issue [[https://github.com/nvim-orgmode/orgmode/issues/281#issuecom
329341
Link to detailed documentation: [[DOCS.md][DOCS]]
330342

331343
** Plugins
344+
:PROPERTIES:
345+
:CUSTOM_ID: plugins
346+
:END:
332347

333348
- [[https://github.com/chipsenkbeil/org-roam.nvim][org-roam.nvim]] - Implementation of [[https://orgroam.com][Org-roam]] knowledge management system
334349
- [[https://github.com/nvim-orgmode/telescope-orgmode.nvim][telescope-orgmode.nvim]] - Telescope extension to find headlines, refile and insert links
@@ -381,6 +396,9 @@ Hosted documentation is on: [[https://nvim-orgmode.github.io/][https://nvim-orgm
381396
- :white_square_button: Support evaluating code blocks
382397

383398
** Thanks to
399+
:PROPERTIES:
400+
:CUSTOM_ID: thanks-to
401+
:END:
384402

385403
- [[https://github.com/dhruvasagar][@dhruvasagar]] and his [[https://github.com/dhruvasagar/vim-dotoo][vim-dotoo]] plugin
386404
that got me started using orgmode. Without him this plugin would not happen.

lua/orgmode/init.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ function Org:init()
5050
:new({
5151
paths = require('orgmode.config').org_agenda_files,
5252
})
53-
:load_sync()
53+
:load_sync(true, 20000)
5454
self.agenda = require('orgmode.agenda'):new({
5555
files = self.files,
5656
})

0 commit comments

Comments
 (0)