Skip to content

README.md

Latest commit

 

History

History
43 lines (29 loc) · 803 Bytes

README.md

File metadata and controls

43 lines (29 loc) · 803 Bytes

BlueLua Docs

Central documentation site for BlueLua's Lua modules, built using VitePress.

Installation

Run the commands from docs/:

npm install

Build and Test Locally

  1. Run this command to build the docs:

    npm run build

  2. Once built, preview it locally by running:

    npm run preview

The preview command boots a local static server that serves the built site from docs/.vitepress/dist at http://localhost:4173.

Note

To use a different port, run npm run preview -- --port 8080.

Local Development

npm run dev

This starts the VitePress dev server at http://localhost:5173.