Skip to content

Commit

Permalink
chore(build): auto-generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Sep 9, 2024
1 parent cacbddb commit 1c14851
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
13 changes: 13 additions & 0 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ config.defaults = {
end
return enabled
end,
max_view_entries = 200,
debug = false,
}
```
Expand Down Expand Up @@ -204,6 +205,18 @@ This can either be top to bottom or so the best match is always next to the curs
Whether debugging should be enabled or not. This will write a log to a `care.log` file
in the current directory.

## Max View Entries
`config.max_view_entries? integer`

The max entries to display in the menu. Note that this just affects
the entries displayed at a time. So there are still more entries on which you
can filter by continue typing. This limit just exists for performance reasons
because there are some sources which return up to multiple thousand
entries through which a user never will scroll.
The default value is 200 which will open the menu instantly in most cases so there
isn't much need for a lower value.
Values of up to about 1000 should also not cause performance issue.

# Ui Configuration
This is used to configure the whole UI of care.
# `care.config.ui`
Expand Down
8 changes: 7 additions & 1 deletion docs/dev/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,10 @@ autocompletion when set to true.
`core.last_opened_at integer`

This variable is used to determine where a new completion window was opened for
the last time. This is used to determine when to reopen the completion window.
the last time. This is used to determine when to reopen the completion window.

## Completing
`core.completing boolean`

Boolean to indicate if care is currently completing. This is used to avoid
compmleting and sorting on the same keystroke.

0 comments on commit 1c14851

Please sign in to comment.