File tree Expand file tree Collapse file tree 1 file changed +47
-1
lines changed
Expand file tree Collapse file tree 1 file changed +47
-1
lines changed Original file line number Diff line number Diff line change 1- # velda-io.github.io
1+ # velda-io.github.io
2+
3+ This repository contains the Velda documentation site (built with VitePress and Tailwind).
4+
5+ ## Development
6+
7+ These are the common commands used while developing and maintaining the site.
8+
9+ Prerequisites
10+
11+ - Node.js (recommend Node 18+)
12+ - npm (or a compatible client)
13+
14+ Install dependencies
15+
16+ ``` bash
17+ npm install
18+ ```
19+
20+ Run local development server (live-reload)
21+
22+ ``` bash
23+ npm run dev
24+ ```
25+
26+ Build the static site (this runs the sitemap generator before building)
27+
28+ ``` bash
29+ npm run build
30+ ```
31+
32+ Preview the built site locally
33+
34+ ``` bash
35+ npm run preview
36+ ```
37+
38+ Sitemap & maintenance scripts
39+
40+ - Generate sitemap: ` npm run sitemap `
41+ - Update blog metadata/posts: ` npm run update-blog-posts `
42+
43+ Notes
44+
45+ - ` build ` runs ` sitemap ` then ` vitepress build ` (see ` package.json ` ).
46+ - Markdown content lives at the repository root (and the ` blog/ ` folder for blog posts). Edit those files and use ` npm run dev ` to preview changes.
47+ - If you run into issues, try removing ` node_modules ` and ` package-lock.json ` , then re-run ` npm install ` .
You can’t perform that action at this time.
0 commit comments