Code powering https://docs.lightbug.io making use of vitepress
Install dependencies
npm install
Run the development server
npm run dev
Or build and serve the static site
npm run build
npm run preview
Merges to the main
branch will auto deploy onto https://docs-next.lightbug.io
The production
branch will deploy to the main site at https://docs.lightbug.io
The site build uses an environment variable DEPLOYMENT_NAME
to alter some config (for example sitemap
and editLink
). CI sets this during the build step. To reproduce CI builds locally you can use the included npm scripts:
npm run build:next
— setsDEPLOYMENT_NAME=Next
(matchesmain
branch/next site)npm run build:production
— setsDEPLOYMENT_NAME=Production
(matchesproduction
branch/main site)
Both scripts use cross-env
so they work cross-platform.