vue-command icon indicating copy to clipboard operation
vue-command copied to clipboard

Documentation: Create more examples

Open ndabAP opened this issue 5 years ago • 4 comments

The main site has only one big example. Create multiple examples how to use the library with code examples. A complete redesign is absolutely possible.

You find the documentation source code here. Start it with npm run serve.

ndabAP avatar Jun 16 '20 05:06 ndabAP

Just to add, because I've been looking over your code and seeing what I can maybe do with it for my needs, but still being kind of new-ish at Vue -- I think more helpful than more example commands would be, "To make a new command that is not writing a string into a component, you need to look here in this file in and take x into account, look in y file and take that into account.

The Auto Complete stuff seems the most heavy I guess. It took me a while to figure out what providing and injecting was but I got it eventually. Either way, examples would be cool, but mainly only if they are instructional in how to add to the engine without breaking it.

shaenr avatar Sep 12 '20 16:09 shaenr

Actually, many of the things you said in the README confused me thoroughly, being pretty new to JS frameworks. But after I looked through all your code and went back and read it, I understand.

shaenr avatar Sep 12 '20 19:09 shaenr

The Auto Complete stuff seems the most heavy I guess.

Definitely, and it's even not yet part of the core. You need to copy paste it from the examples. The plan was to fully integrate it but that needs careful planing. I didn't find the time so far.

Actually, many of the things you said in the README confused me thoroughly, being pretty new to JS frameworks. But after I looked through all your code and went back and read it, I understand.

I'd be very happy for contributions because most stuff is only written by me which means it's only from my perspective.

What I meant with this was more examples at the hosted site here: https://ndabap.github.io/vue-command. I thought like you have code and next to it, you see the result in the terminal.

ndabAP avatar Sep 23 '20 09:09 ndabAP