live-server.nvim/doc/live-server.txt

53 lines
2.2 KiB
Text

*live-server* *live-server.txt*
Author: Barrett Ruth <https://barrettruth.com>
Homepage: <https://github.com/barrett-ruth/live-server.nvim>
===============================================================================
INTRODUCTION *live-server.nvim*
live-server.nvim automatically reloads HTML, CSS, and JavaScript files in the
browser via a local development server.
Author: Barrett Ruth <https://barrett-ruth.github.io>
===============================================================================
SETUP *live-server.setup()*
>lua
require('live-server').setup(config)
<
Parameters: ~
{config} `(table | nil)`: (Optional) table containing configuration for
live-server. Defaults shown below.
Usage: ~
>lua
require('live-server').setup {
-- Arguments passed to live-server via `vim.fn.jobstart()`
-- Run `live-server --help` to see list of available options
-- For example, to use port 7000 and browser firefox:
-- args = { '--port=7000', '--browser=firefox' }
args = {}
}
<
===============================================================================
COMMANDS *live-server.commands*
*LiveServerStart*
:LiveServerStart [dir] Start the live server. If an optional argument `dir`
is provided, the server will start in the specified
directory.
*LiveServerStop*
:LiveServerStop [dir] Stop the live server. If an optional argument `dir`
is provided, the server will stop the server running
in the specified directory.
*LiveServerToggle*
:LiveServerToggle [dir] Toggle the live server on or off. If an optional
argument `dir` is provided, the server will be
toggled in the specified directory.
-------------------------------------------------------------------------------
vim:tw=80:ft=help: