docs: lighten up readme and rework docs (#1327)
* docs: lighten up readme and rework docs * docs: clean up mappings from readme + some other small changes * docs: move sections around * ci: remove readme parts of docs' autogen * docs: discuss nvim-web-devicons and provide an example * docs: add an example setup * docs: fix opts scraping; try and make more macos compatible * docs: add *nvim-tree* tag at start of help * docs: add an example setup * docs: update quick start to match readme * docs: add basic commands * docs: add g? hint * docs: add :help links to readme * docs: restore help wanted * docs: add example screenshot * docs: add features * docs: add example screenshot * docs: add features to help * docs: clarify option functions Co-authored-by: Alexander Courtis <alex@courtis.org>
This commit is contained in:
@@ -82,23 +82,3 @@ for _, m in pairs(outs_lua) do
|
||||
io.write(string.format(fmt, m.key, m.action))
|
||||
end
|
||||
io.close(file)
|
||||
|
||||
-- md
|
||||
file = io.open("/tmp/DEFAULT_MAPPINGS.md", "w")
|
||||
io.output(file)
|
||||
io.write "| Default Keys | Action | Description |\n"
|
||||
io.write "| - | - | - |\n"
|
||||
for _, m in pairs(M.mappings) do
|
||||
local keys = ""
|
||||
if type(m.key) == "table" then
|
||||
local first = true
|
||||
for _, sub_key in pairs(m.key) do
|
||||
keys = keys .. (first and "" or " <br /> ") .. sub_key:gsub("<", "\\<")
|
||||
first = false
|
||||
end
|
||||
else
|
||||
keys = m.key:gsub("<", "\\<")
|
||||
end
|
||||
io.write(string.format("| %s | %s | %s |\n", keys, m.action, m.desc:gsub("|", "`")))
|
||||
end
|
||||
io.close(file)
|
||||
|
||||
Reference in New Issue
Block a user