ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Live​Server

by molnarmark ST3

🌍️ Launch a Development Server directly from Sublime Text

Details

  • 1.0.0
  • github.​com
  • github.​com
  • 3 months ago
  • 58 minutes ago
  • 2 months ago

Installs

  • Total 3K
  • Win 2K
  • Mac 229
  • Linux 402
Mar 4 Mar 3 Mar 2 Mar 1 Feb 28 Feb 27 Feb 26 Feb 25 Feb 24 Feb 23 Feb 22 Feb 21 Feb 20 Feb 19 Feb 18 Feb 17 Feb 16 Feb 15 Feb 14 Feb 13 Feb 12 Feb 11 Feb 10 Feb 9 Feb 8 Feb 7 Feb 6 Feb 5 Feb 4 Feb 3 Feb 2 Feb 1 Jan 31 Jan 30 Jan 29 Jan 28 Jan 27 Jan 26 Jan 25 Jan 24 Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18
Windows 5 60 43 56 44 46 60 50 56 67 47 44 50 54 52 60 55 47 42 46 49 63 61 52 59 71 56 41 48 71 61 60 53 43 64 46 61 70 64 61 66 64 61 70 55 56
Mac 1 5 5 7 3 5 4 2 4 7 8 3 2 7 1 9 6 3 7 2 6 5 9 1 5 5 7 3 3 2 6 5 3 2 5 12 5 7 11 7 1 9 6 5 9 5
Linux 1 11 8 6 12 2 14 4 13 18 5 10 9 5 11 11 7 9 9 5 9 10 14 12 8 14 13 9 10 13 10 13 3 10 9 12 11 10 8 15 8 9 7 10 12 7

Readme

Source
raw.​githubusercontent.​com

Launch a Development Server directly from Sublime Text!

📋 Introduction

This package integrates the Live Server Node package, giving the ability to launch a local development server to serve content directly from Sublime Text.

For this package to work, you need to have a folder opened inside your editor. That will be the root path the server starts serving on.

💡 About Live Server:

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.

❗Prerequisites

You need the following software installed to use Live Server.

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

🌀 Installation

Package Control

Live Server is currently awaiting to be added to Package Control.

[comment]: <> (This package is available in Package Control under the name Live Server.)

As a Repository

If this package isn't on Package Control at the time you are trying to install it,

❓ Usage

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.

🔨 Settings

To change your settings, bring up the Command Palette and select: Preferences: Live Server Settings

The default settings 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
}

node_executable_path

  • Path to the Node runtime executable. You can run whereis node in your terminal to find this.
  • ##### default: /usr/bin/node

global_node_modules_path

  • Path to the default node_modules directory. You can run npm root -g** or **yarn global bin in your terminal to find this.
  • ##### default: /usr/local/lib/node_modules

port

  • The default port for the server.
  • ##### default: 8080

address

  • Host address. This should always be either localhost or 127.0.0.1.
  • ##### default: localhost

cors

  • Enables CORS for any origin.
  • ##### default: true

browser

  • Specifies which browser to use.
  • Valid values are:

    • default
    • google-chrome
    • firefox
  • default: default

nobrowser

  • By setting this to true, the browser will not open the server by default
  • ##### default: false

wait

  • Wait this amount of milliseconds before reloading the page after a change
  • ##### default: 100

🔖 Credits