This repository contains the Velda documentation site (built with VitePress and Tailwind).
These are the common commands used while developing and maintaining the site.
Prerequisites
- Node.js (recommend Node 18+)
- npm (or a compatible client)
Install dependencies
npm installRun local development server (live-reload)
npm run devBuild the static site (this runs the sitemap generator before building)
npm run buildPreview the built site locally
npm run previewSitemap & maintenance scripts
- Generate sitemap:
npm run sitemap - Update blog metadata/posts:
npm run update-blog-posts
Notes
buildrunssitemapthenvitepress build(seepackage.json).- Markdown content lives at the repository root (and the
blog/folder for blog posts). Edit those files and usenpm run devto preview changes. - If you run into issues, try removing
node_modulesandpackage-lock.json, then re-runnpm install.