Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: expose GpConfig #207

Merged
merged 1 commit into from
Sep 10, 2024
Merged

docs: expose GpConfig #207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions lua/gp/config.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
-- Default config
--------------------------------------------------------------------------------

---@class GpConfig
-- README_REFERENCE_MARKER_START
local config = {
-- Please start with minimal config possible.
Expand Down Expand Up @@ -317,11 +318,12 @@ local config = {
-- use prompt buftype for chats (:h prompt-buffer)
chat_prompt_buf_type = false,

-- how to display GpChatToggle or GpContext: popup / split / vsplit / tabnew
-- how to display GpChatToggle or GpContext
---@type "popup" | "split" | "vsplit" | "tabnew"
toggle_target = "vsplit",

-- styling for chatfinder
-- border can be "single", "double", "rounded", "solid", "shadow", "none"
---@type "single" | "double" | "rounded" | "solid" | "shadow" | "none"
style_chat_finder_border = "single",
-- margins are number of characters or lines
style_chat_finder_margin_bottom = 8,
Expand All @@ -332,7 +334,7 @@ local config = {
style_chat_finder_preview_ratio = 0.5,

-- styling for popup
-- border can be "single", "double", "rounded", "solid", "shadow", "none"
---@type "single" | "double" | "rounded" | "solid" | "shadow" | "none"
style_popup_border = "single",
-- margins are number of characters or lines
style_popup_margin_bottom = 8,
Expand Down
2 changes: 1 addition & 1 deletion lua/gp/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ end

-- setup function
M._setup_called = false
---@param opts table | nil # table with options
---@param opts GpConfig? # table with options
M.setup = function(opts)
M._setup_called = true

Expand Down
Loading