Improving documentation - Creating Vitepress documentation

[linspw]

Hello, my name is Jessé, I really liked this library, it proved to be much easier and safer than other implementations.

I want to contribute to the project to grow and improve.

In this PR, I'm creating Vitepress, official vue 3 documentation tool

It's simple, beautiful and lets you use live examples.

If they accept this implementation, I will go after a way to deploy it (in another PR).

Thank you very much in advance!

Screenshot:

Changes:

• Add Vitepress
• Everthing about Vitepress is created in /docs
• /img moved to /docs/img (made a big difference in PR).

[nicholaszuccarelli]

Hi Jesse

Thanks a lot for this pull request. Vitepress looks nice and it should work nicely to modernise the docs for this package.

I’m not very familiar with how Vitepress works (i might need to look deeper into your pull request) but I assume you’ve rewritten our docs to work with Vitepress?

If you are able to consolidate it and make sure Vite works properly I’ll be happy to accept it and replace our docs with it. Need to work out how to host the files on GitHub :)

-Nick

[linspw]

Hello Nicholas, thank you for your attention.

Vitepress is very simple, it practically uses MD files to present the documentation.

And after the build process is done, the website it generates statically is ready to deploy.

And yes, we can use GitHub Pages, it will work just fine.

https://vitepress.dev/guide/deploy#github-pages

About the documentation I transcribed from README.md, just add the features section of the Vitepress main page, feel free to change it for what you think is best. https://github.com/rlemaigre/Easy-DnD/pull/139/files#r1171449562

About Vite, it is used internally by Vitepress and does not impact this PR in the library itself.

I'm going to open another PR with the GitHub Pages deploy.

Many thanks again Nicholas!

Jessé

[linspw]

PR with deploy: https://github.com/linspw/Easy-DnD/pull/1

Link with documentation (will be set to the main domain): https://linspw.github.io/Easy-DnD/

[rlemaigre]

This is so cool.

Very rewarding to see that my little project still generates some interest and has been picked up by people who contribute and maintain it now that I don't really use it myself anymore (it's been some time since I last needed drag and drop in a project of mine).

Many thanks.

[linspw]

I thank @rlemaigre, it's a pleasure to be able to contribute, I want to bring more contributions if they allow me (I have in mind developing tests in the future)

Is there any prediction about the acceptance of these improvements?

Thanks in advance.

[nicholaszuccarelli]

Hey Jesse. Sorry I got extremely busy and just forgot about this. I'll take a look at it today :)

[nicholaszuccarelli]

@rlemaigre I have set it up and pushed to master. One step I need you to do from Vitepress:

In your repository's Settings under Pages menu item, select GitHub Actions in Build and deployment's Source. https://vitepress.dev/guide/deploy#github-pages

I've set up the config files etc, just need you to enable Github Pages in the project settings (I don't have access to it).

[nicholaszuccarelli]

@linspw If you happen to have time and want to contribute more, some updated codepens which use Vue3 would be amazing. The current codepens are very out of date.

[rlemaigre]

@rlemaigre I have set it up and pushed to master. One step I need you to do from Vitepress:

In your repository's Settings under Pages menu item, select GitHub Actions in Build and deployment's Source. https://vitepress.dev/guide/deploy#github-pages

I've set up the config files etc, just need you to enable Github Pages in the project settings (I don't have access to it).

I've enabled Github Pages with Github Actions as you requested. Let me know if there is anything more I need to do. The Pages panel looks like this now :

[nicholaszuccarelli]

I think that is it. I'm not at my PC right now. Are u able to make a blank commit on master? It should automatically then create the github pages website.

[nicholaszuccarelli]

https://rlemaigre.github.io/Easy-DnD/

Deployed and live! Thanks a lot @linspw for setting this up.

[rlemaigre]

Many thanks to both of you :)

[linspw]

I thank you @nicholaszuccarelli @rlemaigre, I'll see if I can bring more improvements in my free time