live-server-web-extension
live-server-web-extension copied to clipboard
ritwickdey
A good video tutorial & nice documentation
- modify the existing documentation
- a good video tutorial
[For video tutorial, it should be within 3/4 min (for each method), and less description about how to install the extension]
[I'm now seriously busy (for my exam)]
I made a draft video tutorial in here https://www.youtube.com/watch?v=54wcX1G2GH8
Ok, I could give it a try.
The first thing to sort out.
This is a browser extension and the documentation has different views in Chrome and Firefox. I prefer to have the premier and clearest documentation on GitHub and thus guide the visitors there. I also prefer that you have a docs folder with documentation, instead of README.md. And then we can make the browser's documentation more accurate for every browser with YouTube videos as well.
According to me, README should be a simpler overview of the application, with a brief description, versions, licenses and more...
What do you think of that idea?
- [x] Brief description
- [x] docs/Set_Up.md (Here's how to set settings in different environments)
- [x] docs/About.md (Information about why you chose to build the extension, and about the need it meets.)
- [ ] YouTube video (What it is)
- [ ] YouTube video (How to set up)
I have written a short description that you can paste into the README file, and the add-on product page. Let me know if you have any objections, or if I miss any detail. I have explained what it is for and I have described what environments it supports in addition to html.
## What the Add-on Does
This browser add-on is an extension for a developer tool in VS Code editor ([Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer)). With this add-on installed, along with the VS Code extension, it gives you a functionality to automatically update your website on save; for other files than just `.htm` and `.html`.
So, more specifically, with this add-on, live reload will also work with the following server files like: `PHP`, `Node.js` and `ASP.NET`.
The next step is a link to docs/Set_Up.md that I have started typing on.
Hi, @Mikael-Sundstrom, Thanks Again for your interest. Btw Great Idea 👍
One thing I want to share... this kind of copy pasting is bad idea! Please fork the repo, make the changes whatever you mentioned & make pull request, I'll merge it 1000% 😄. Then I'll check if any if any thing is missing or not!
I haven't understood the anatomy of GitHub yet. So maybe it's time for me to learn it. I'll give it a try.
Not a problem. I'll help you if need!
My email address [email protected], Facebook : www.facebook.com/DeyRitwick ,
kindly contact me, I'll help you! (I'm very active on FACEBOOK 😸 )
