Skip to content

Commit f409c1a

Browse files
committed
docs: add README
1 parent 6914706 commit f409c1a

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# BlueLua Docs
2+
3+
Central documentation site for [BlueLua](https://github.com/BlueLua)'s Lua
4+
modules, built using [VitePress](https://vitepress.dev/).
5+
6+
## Installation
7+
8+
Run the commands from [docs/](docs/):
9+
10+
```sh
11+
npm install
12+
```
13+
14+
## Build and Test Locally
15+
16+
1. Run this command to build the docs:
17+
18+
```sh
19+
npm run build
20+
```
21+
22+
2. Once built, preview it locally by running:
23+
24+
```sh
25+
npm run preview
26+
```
27+
28+
The `preview` command boots a local static server that serves the built site
29+
from [docs/.vitepress/dist](docs/.vitepress/dist) at
30+
[http://localhost:4173](http://localhost:4173).
31+
32+
> [!NOTE]
33+
>
34+
> To use a different port, run `npm run preview -- --port 8080`.
35+
36+
## Local Development
37+
38+
```sh
39+
npm run dev
40+
```
41+
42+
This starts the VitePress dev server at
43+
[http://localhost:5173](http://localhost:5173).

0 commit comments

Comments
 (0)