Skip to content

Commit

Permalink
chore(build): auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
astronvimbot committed Feb 6, 2024
1 parent e2df9f0 commit 2153eaf
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
6 changes: 4 additions & 2 deletions doc/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,14 @@ function astrocore.empty_map_table()


```lua
function astrocore.event(event: string)
function astrocore.event(event: string|vim.api.keyset_exec_autocmds, instant?: boolean)
```

Trigger an AstroNvim user event

*param* `event` — The event name to be appended to Astro
*param* `event` — The event pattern or full autocmd options (pattern always prepended with "Astro")

*param* `instant` — Whether or not to execute instantly or schedule

### extend_tbl

Expand Down
11 changes: 7 additions & 4 deletions doc/astrocore.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*astrocore.txt* For Neovim >= 0.9.0 Last change: 2024 February 05
*astrocore.txt* For Neovim >= 0.9.0 Last change: 2024 February 06

==============================================================================
Table of Contents *astrocore-table-of-contents*
Expand Down Expand Up @@ -145,7 +145,7 @@ usages:
cmp = true, -- enable or disable cmp on start
highlighturl = true, -- enable or disable highlighting of urls on start
-- table for defining the size of the max file for all features, above these limits we disable features like treesitter.
max_file = { size = 1024 * 100, lines = 10000 },
large_buf = { size = 1024 * 100, lines = 10000 },
notifications = true, -- enable or disable notifications on start
},
-- Enable git integration for detached worktrees
Expand Down Expand Up @@ -285,12 +285,15 @@ _return_ — a table with entries for each map mode
EVENT ~

>lua
function astrocore.event(event: string)
function astrocore.event(event: string|vim.api.keyset_exec_autocmds, instant?: boolean)
<

Trigger an AstroNvim user event

_param_ `event` — The event name to be appended to Astro
_param_ `event` — The event pattern or full autocmd options (pattern always
prepended with "Astro")

_param_ `instant` — Whether or not to execute instantly or schedule


EXTEND_TBL ~
Expand Down

0 comments on commit 2153eaf

Please sign in to comment.