neorg icon indicating copy to clipboard operation
neorg copied to clipboard

add cheatsheet

Open max397574 opened this issue 2 years ago • 7 comments

closes https://github.com/nvim-neorg/neorg/issues/419

max397574 avatar Apr 18 '22 12:04 max397574

for now I just copied that example file We should change that though

max397574 avatar Apr 18 '22 12:04 max397574

@premell is this what you thought about?

max397574 avatar Apr 18 '22 18:04 max397574

@vhyrro the tests that fail have nothing to do with this pr right?

max397574 avatar Apr 18 '22 18:04 max397574

Tests failing are "normal" :p

If i get some time i'll populate the contents of the cheatsheet to have something more enticing than just a copy of the example file

vhyrro avatar Apr 19 '22 09:04 vhyrro

I don't think it's a good idea to effectively duplicate the examples file in this format. We already have too many files which need to be kept consistent and with the formal syntax specification moving to the TS repo, the documentation over here will also need to be overhauled. Just my two cents..

mrossinek avatar Apr 19 '22 10:04 mrossinek

Yes for now I just added the example file (added links) because it was mainly about the floating window things etc Eventually we should write a compact cheatsheet

max397574 avatar Apr 19 '22 10:04 max397574

@vhyrro ?

max397574 avatar Jul 08 '22 21:07 max397574

I've just spent a bit of time compiling a larger cheatsheet that is just a simple helpfile for the time being (:h neorg-cheatsheet). In my opinion we should close this PR and we can work from the ground up on a solution that revolves around the new cheatsheet file with features like "show automatically when it's the user's first time installing neorg", a tutorial mode (if you've seen conjure's tutorial then i'd love something along those lines) and so on.

This PR not being merged became kind of a meme at this point but it can't just be here forever :smile:

vhyrro avatar May 01 '23 14:05 vhyrro