Merge pull request #26 from barrettruth/docs/modernize-readme
docs: modernize readme
This commit is contained in:
commit
76199cefaa
1 changed files with 2 additions and 25 deletions
27
readme.md
27
readme.md
|
|
@ -5,7 +5,7 @@ Live reload HTML, CSS, and JavaScript files inside Neovim with the power of
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Install using your package manager of choice or via
|
Install with your package manager or via
|
||||||
[luarocks](https://luarocks.org/modules/barrettruth/live-server.nvim):
|
[luarocks](https://luarocks.org/modules/barrettruth/live-server.nvim):
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
@ -14,30 +14,7 @@ luarocks install live-server.nvim
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
- [live-server](https://www.npmjs.com/package/live-server) (install globally via
|
- [live-server](https://www.npmjs.com/package/live-server) (install globally via npm/yarn)
|
||||||
npm/pnpm/yarn)
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Configure via `vim.g.live_server` before the plugin loads:
|
|
||||||
|
|
||||||
```lua
|
|
||||||
vim.g.live_server = {
|
|
||||||
args = { '--port=5555' },
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
See `:help live-server` for available options.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```vim
|
|
||||||
:LiveServerStart [dir] " Start the server
|
|
||||||
:LiveServerStop [dir] " Stop the server
|
|
||||||
:LiveServerToggle [dir] " Toggle the server
|
|
||||||
```
|
|
||||||
|
|
||||||
The server runs by default on `http://localhost:5555`.
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue