This package integrates the Live Server Node package, giving the ability to launch a local development server to serve content directly from Sublime Text.
Live Server is Node.js tool that spins up a local development server in the given directory.
It features live browser reloading, which simply means that your browser will automatically refresh the page when any change is made to your HTML & CSS files.
Useful for static sites, SPAs, and general HTML/CSS fiddling.
You need the following software installed to use Live Server.
Node.js
npm
orYarn
Live Server
installed globally
To install Live Server globally using npm
, run:
npm install -g live-server
To install Live Server globally using Yarn
, run:
yarn global add live-server
This package is available in Package Control under the name LiveServer.
- Bring up the Command Palette (Ctrl + Shift + p)
- Select
Package Control: Add Repository
- Paste https://github.com/molnarmark/sublime-live-server
- Press Enter
- For Windows machine, you need to change the package's config settings, check below ๐จ Settings
This package exposes 3 commands that can be used directly via the Command Palette, or bound to keys. These are:
Live Server: Start
- Maps to
live_server_start
Live Server: Stop
- Maps to
live_server_stop
Live Server: Open In Browser
- Maps to
live_server_open_in_browser
Status bar messages with indicator emojis are implemented into the package, displaying information in cases such as:
- ๐ Live Server running
- โ Live Server stopped
- โ๏ธ Live Server status
When the development server is running, a status message will be shown in the status bar indicating that the server is running. This is shared across all views in the opened instance.
To change your settings, bring up the Command Palette and select: Preferences: Live Server Settings
The default settings for linux are the following:
// Note: These are just mappings to https://github.com/tapio/live-server#usage-from-command-line
{
"node_executable_path": "/usr/bin/node",
"global_node_modules_path": "/usr/local/lib/node_modules",
"port": 8080,
"address": "localhost",
"cors": true,
"browser": "default",
"nobrowser": false,
"wait": 100
}
- Path to the Node runtime executable. You can run
whereis node
in your terminal to find this.- In Windows Command Prompt, run
where node
- In Windows Command Prompt, run
- Path to the default node_modules directory. You can run
npm root -g
oryarn global bin
in your terminal to find this.
- The default port for the server.
- Host address. This should always be either localhost or 127.0.0.1.
- Enables CORS for any origin.
-
Specifies which browser to use.
-
Valid values are:
default
google-chrome
firefox
- By setting this to true, the browser will not open the server by default
- Wait this amount of milliseconds before reloading the page after a change
- This package wouldn't exist without the amazing
Node
package also called Live Server by Tapio Vierros.