Comments (8)
related: create and link a cheat sheet like this for newcomers.
from nvim-lua-guide.
Thank you for the kind words! I'm glad this guide is useful to you :)
In its current state, I don't think it could be merged as-is: some sections need to be polished/finished and there's a lot of overlap with the existing documentation. I'd be happy to contribute parts of it, though!
In the meantime, I could try and convert it to a vim help file so people could install it as a plugin. You could then generate tags for it and you'd be able to use it as a quick reference. Is this something you would find useful?
from nvim-lua-guide.
Is this something you would find useful?
I would love that! I think turning the page into a help page is an excellent idea
I agree there's some repeated info. But the examples are pretty awesome. I would like to use this issue to suggest chunks, that I think neovim help could benefit from. It's that's okay?
Thanks!
from nvim-lua-guide.
Yeah this guide is awesome. Thanks for this
from nvim-lua-guide.
(Which is of course not an argument against providing this guide also as a vimdoc plugin!)
That's the plan! The guide now has a vimdoc version in addition to the markdown file.
I do wish the format was a little nicer to work with, especially regarding conversion. This would make it much easier to output HTML or Markdown
from nvim-lua-guide.
Thanks again for all there great references posted here! I think this issue can be closed. Is up to you @nanotee ....
from nvim-lua-guide.
Sure! Knowing what people find useful can help improve the guide, too
from nvim-lua-guide.
In the meantime, I could try and convert it to a vim help file so people could install it as a plugin. You could then generate tags for it and you'd be able to use it as a quick reference. Is this something you would find useful?
To be honest, I think it's more accessible and findable as markdown/html -- in fact, I'd rather have nvim help as a proper HTML documentation, with a table of contents sidebar and a search field (like readthedocs.org, for example)...
(Which is of course not an argument against providing this guide also as a vimdoc plugin!)
from nvim-lua-guide.
Related Issues (20)
- neovim autocommands got merged, describe them in guide HOT 4
- threading support for lua via libuv got merged, link to good tutorial on usage
- suggestions on how to reload keymaps and options
- How to get &ft from lua HOT 4
- Describe how to create user commands that support ranges
- explain that `vim.api.nvim_set_keymap(mode, ..)` is first char of `:lua print(vim.api.nvim_get_mode().mode)` and hint that there is a minor mode HOT 2
- FFI Library: calling native C function
- Remove problematic flags emoji
- Can we use this guide in Neovim? HOT 3
- Add a Table of content HOT 1
- add protected call for make sure the first run will work properlly
- add recommended formatter setup for lua and nvim lua plugin template
- Question: lua replacement for `executable()`? HOT 2
- how to read the command arguments `:command arg1 arg2` with lua HOT 2
- vim.api.nvim_exec() example gives error HOT 1
- lua user commands pr landed, so describe them in guide HOT 1
- Improper handling of relative paths with spaces HOT 2
- How to let `vim.cmd` accept the range from visual selection HOT 1
- Create keymap to open new file adjacent to current file HOT 6
- DEPRECATED replaced by mode option HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from nvim-lua-guide.