jalvesaq / zotcite

Neovim plugin for integration with Zotero
GNU General Public License v3.0
159 stars 13 forks source link

Changes to documentation #86

Closed adam-coates closed 3 weeks ago

adam-coates commented 1 month ago

My last pull request I forgot to add and example of running the :Zselectannotations command in the doc.

Not sure if the README.md on the github page could also showcase this. But in the interest of keeping the readme uniform, I'd refrain from making a pull request to avoid differences in colorscheme/ example references in the gifs in the readme.

jalvesaq commented 1 month ago

It's OK to have differences in style (colorscheme, etc). I see this as good (diversity in appearance over standardization).

adam-coates commented 1 month ago

Okay then perhaps I can also update the readme as well.

jalvesaq commented 1 month ago

Yes, please, update the README and I'll say if I think something could be improved in your changes.

Also, instead of removing lua from >lua, perhaps adding the language name of all code blocks in the documentation will be better. This is something that didn't work in Vim, but we can do it for Neovim.

adam-coates commented 4 weeks ago

Okay I'm happy to do this, it's on todo list.

adam-coates commented 3 weeks ago

So I updated the README, and I added back the lua into the doc. I was unsure about the other code blocks though. Let me know what you think.

jalvesaq commented 3 weeks ago

Nice screenshots! Thank you!

adam-coates commented 3 weeks ago

You're welcome thanks!

jalvesaq commented 3 weeks ago

I added the language tags that were missing to the code blocks.

adam-coates commented 3 weeks ago

Great thanks for doing that!