subcrip
/
lazy.nvim
mirror of https://github.com/folke/lazy.nvim.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: generated docs

This commit is contained in:
Folke Lemaitre 2023-01-19 22:08:58 +01:00
parent 4739c2d95a
commit 3f8cc2c0df
No known key found for this signature in database
GPG Key ID: 41F8B1FBACAE2040
2 changed files with 38 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -80,7 +80,7 @@ require("lazy").setup({
## 🔌 Plugin Spec ## 🔌 Plugin Spec
| Property | Type | Description | | Property | Type | Description |
| ---------------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `[1]` | `string?` | Short plugin url. Will be expanded using `config.git.url_format` | | `[1]` | `string?` | Short plugin url. Will be expanded using `config.git.url_format` |
| **dir** | `string?` | A directory pointing to a local plugin | | **dir** | `string?` | A directory pointing to a local plugin |
| **url** | `string?` | A custom git url where the plugin is hosted | | **url** | `string?` | A custom git url where the plugin is hosted |
@ -330,6 +330,7 @@ return {
ui = { ui = {
-- a number <1 is a percentage., >1 is a fixed size -- a number <1 is a percentage., >1 is a fixed size
size = { width = 0.8, height = 0.8 }, size = { width = 0.8, height = 0.8 },
wrap = true, -- wrap the lines in the ui
-- The border to use for the UI window. Accepts same border values as |nvim_open_win()|. -- The border to use for the UI window. Accepts same border values as |nvim_open_win()|.
border = "none", border = "none",
icons = { icons = {
@ -438,6 +439,7 @@ return {
-- only generate markdown helptags for plugins that dont have docs -- only generate markdown helptags for plugins that dont have docs
skip_if_doc_exists = true, skip_if_doc_exists = true,
}, },
state = vim.fn.stdpath("state") .. "/lazy/state.json", -- state info for checker and other things
} }
``` ```

12
lua/lazy/docs.lua
View File

@ -14,21 +14,27 @@ end
function M.fix_indent(str) function M.fix_indent(str)
local lines = vim.split(str, "\n") local lines = vim.split(str, "\n")
local first = table.remove(lines, 1)
local width = 120 local width = 120
for _, line in ipairs(lines) do for _, line in ipairs(lines) do
if not line:find("^%s*$") then
width = math.min(width, #line:match("^%s*")) width = math.min(width, #line:match("^%s*"))
end end
end
for l, line in ipairs(lines) do for l, line in ipairs(lines) do
lines[l] = line:sub(width + 1) lines[l] = line:sub(width + 1)
end end
table.insert(lines, 1, first)
return table.concat(lines, "\n") return table.concat(lines, "\n")
end end
---@alias ReadmeBlock {content:string, lang?:string} ---@alias ReadmeBlock {content:string, lang?:string}
---@param contents table<string, ReadmeBlock|string> ---@param contents table<string, ReadmeBlock|string>
function M.save(contents) ---@param readme_file? string
local readme = Util.read_file("README.md") function M.save(contents, readme_file)
local readme = Util.read_file(readme_file or "README.md")
for tag, block in pairs(contents) do for tag, block in pairs(contents) do
if type(block) == "string" then if type(block) == "string" then
block = { content = block, lang = "lua" } block = { content = block, lang = "lua" }
@ -48,7 +54,7 @@ function M.save(contents)
end end
end end
Util.write_file("README.md", readme) Util.write_file(readme_file or "README.md", readme)
vim.cmd.checktime() vim.cmd.checktime()
end end