https://github.com/ritwickdey/vscode-live-server
Launch a development local Server with live reload feature for static & dynamic pages.
https://github.com/ritwickdey/vscode-live-server
live-reload live-server livereload typescript vscode vscode-extension
Last synced: 5 months ago
JSON representation
Launch a development local Server with live reload feature for static & dynamic pages.
- Host: GitHub
- URL: https://github.com/ritwickdey/vscode-live-server
- Owner: ritwickdey
- License: mit
- Created: 2017-06-27T20:35:26.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-07T04:55:29.000Z (about 1 year ago)
- Last Synced: 2025-04-18T22:43:16.287Z (6 months ago)
- Topics: live-reload, live-server, livereload, typescript, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://ritwickdey.github.io/vscode-live-server
- Size: 5.25 MB
- Stars: 6,135
- Watchers: 151
- Forks: 1,430
- Open Issues: 2,287
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome - ritwickdey/vscode-live-server - Launch a development local Server with live reload feature for static & dynamic pages. (TypeScript)
- jimsghstars - ritwickdey/vscode-live-server - Launch a development local Server with live reload feature for static & dynamic pages. (TypeScript)
- awesome-starred - ritwickdey/vscode-live-server - Launch a development local Server with live reload feature for static & dynamic pages. (TypeScript)
- awesome-starred - ritwickdey/vscode-live-server - Launch a development local Server with live reload feature for static & dynamic pages. (TypeScript)
- StarryDivineSky - ritwickdey/vscode-live-server - live-server 是一个为 Visual Studio Code 设计的轻量级本地开发服务器扩展，其核心功能是通过“实时重载”技术实现网页开发时的自动刷新。该工具通过监听项目文件（如 HTML、CSS、JavaScript 或动态语言如 PHP、Node.js 等）的修改，自动触发浏览器刷新，无需手动操作，显著提升开发效率。项目特别强调对静态页面（如 HTML 静态文件）和动态页面（如运行时需服务器处理的 PHP、Python 等）的兼容性，开发者只需在 VS Code 中安装扩展并启动服务器，即可通过右键菜单或快捷键快速启动服务，浏览器会自动打开指定页面并实时同步修改内容。其工作原理基于文件系统监视（watcher）机制，当检测到文件变更时，服务器会向连接的浏览器发送信号，触发页面刷新，同时支持多语言环境和跨平台使用。项目还提供简单的配置选项（如指定服务器端口或根目录），且与 VS Code 编辑器深度集成，无需额外依赖，适合前端开发、本地服务器测试等场景。由于其操作便捷性和对常见开发语言的广泛支持，该工具已成为 VS Code 生态中广受开发者欢迎的实用插件。 (编辑器 / 资源传输下载)
README
_[Wanna try [LIVE SERVER++](https://github.com/ritwickdey/vscode-live-server-plus-plus) (BETA) ? It'll enable live changes without saving file. https://github.com/ritwickdey/vscode-live-server-plus-plus ]_
# Live Server
**Live Server loves** 💘 **your multi-root workspace**
> **Live Server for server side pages like PHP. [Check Here](https://github.com/ritwickdey/live-server-web-extension)**
> ***[For 'command not found error' [#78](https://github.com/ritwickdey/vscode-live-server/issues/78)]***
[](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) [](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) [](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer)
[](https://travis-ci.org/ritwickdey/vscode-live-server) [](https://ci.appveyor.com/project/ritwickdey/vscode-live-server) [](https://github.com/ritwickdey/vscode-live-server/)
**Launch a local development server with live reload feature for static & dynamic pages.**
## Shortcuts to Start/Stop Server
**_[NOTE: In case if you don't have any `.html` or `.htm` file in your workspace then you have to follow method no 4 & 5 to start server.]_**
1. Open a project and click to `Go Live` from the status bar to turn the server on/off.
2. Right click on a `HTML` file from Explorer Window and click on `Open with Live Server`.
.
3. Open a HTML file and right-click on the editor and click on `Open with Live Server`.
4. Hit `(alt+L, alt+O)` to Open the Server and `(alt+L, alt+C)` to Stop the server (You can change the shortcut form keybinding). *[On MAC, `cmd+L, cmd+O` and `cmd+L, cmd+C`]*
5. Open the Command Pallete by pressing `F1` or `ctrl+shift+P` and type `Live Server: Open With Live Server ` to start a server or type `Live Server: Stop Live Server` to stop a server.
## Features
* A Quick Development Live Server with live browser reload.
* Start or Stop server by a single click from status bar.
* Open a HTML file to browser from Explorer menu.[[Quick Gif Demo](./images/Screenshot/vscode-live-server-explorer-menu-demo-1.gif?raw=true)].
* Support for excluding files for change detection.
* Hot Key control.
* Customizable Port Number, Server Root, default browser.
* Support for any browser _(Eg: Firefox Nightly)_ using advance Command Line.
* Support for Chrome Debugging Attachment (_[More Info](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome)_). [[Quick Gif Demo](./images/Screenshot/ChromeDebugging.gif?raw=true)].
* Remote Connect through WLAN (E.g.: Connect with mobile) _[Need Help? See FAQ Section]_
* Use preferable host name *(localhost or 127.0.0.1)*.
* Customizable Supporting Tag for Live Reload feature. (Default is `Body` or `head`)
* SVG Support
* `https` Support.
* Support for proxy.
* CORS Enabled
* Multi-root workspace supported.
* Support for any file even dynamic pages through *[Live Server Web Extension](https://github.com/ritwickdey/live-server-web-extension)*.
## Installation
Open VSCode and type `ctrl+P`, type `ext install ritwickdey.liveserver`.
## Settings
All settings are now listed here [Settings Docs](./docs/settings.md).
## FAQs
*All FAQs are now listed here [FAQ Docs](./docs/faqs.md)*
## What's new ?
* ### Version 5.6.1 (17.04.19)
* Fixed `Extension host terminated unexpectedly` *[[#431](https://github.com/ritwickdey/vscode-live-server/issues/431)]*
* ### Version 5.6.0 (17.04.19)
* ***[NEW]*** Intregation of `Browser Preview` with `Live Server` *[[#352](https://github.com/ritwickdey/vscode-live-server/pull/352) - Thanks to [Kenneth Auchenberg](https://github.com/auchenberg)]*
* ***[NEW]*** Fallback to random port If given port is busy. *[[#330](https://github.com/ritwickdey/vscode-live-server/pull/330) - Thanks to [Ali Almohaya](https://github.com/Almo7aya) ]*
* ***[FIXES]*** Moved to `vscode-chokidar` lib for *[#285](https://github.com/ritwickdey/vscode-live-server/issues/285)*.
* Doc Fixes *[[#388](https://github.com/ritwickdey/vscode-live-server/pull/388) - Thanks to [Ted Silbernagel](https://github.com/tedsilb)]*
* ### Version 5.5.1 (12.02.19)
* ***[Fixes]*** Fixed `Extension host terminated unexpectedly` for MacOS. [[#285](https://github.com/ritwickdey/vscode-live-server/issues/285)]
* ### Version 5.5.0 (12.02.19)
* ***[Fixes]*** Fixed `ignoreFiles` settings [[#255](https://github.com/ritwickdey/vscode-live-server/issues/255)]
* Attempt to fix `high cpu load` [[#278](https://github.com/ritwickdey/vscode-live-server/issues/278)]
## Changelog
To check full changelog [click here](CHANGELOG.md).
## Special Thanks To Maintainers
A special thanks to [Max Schmitt](https://github.com/mxschmitt), [Joydip Roy](https://github.com/rjoydip) & [Ayo Adesugba](https://github.com/adesugbaa) for contributing their valueable time on this project.
[](https://github.com/mxschmitt)
[](https://github.com/rjoydip)
[](https://github.com/adesugbaa)
## LICENSE
This extension is licensed under the [MIT License](LICENSE)