diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 898485681..e7bb31b0f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -174,7 +174,7 @@ cd docs 2. **Start the Local Development Server** ```sh - pnpm run docs:dev +pnpm dev ``` 3. **Open the Website Locally** diff --git a/docs/README.md b/docs/README.md index 026807c08..c84b0cb24 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,6 +2,7 @@ The Lucide docs website is built with Vitepress: https://vitepress.dev/ This is Markdown-based documentation powered by Vue. +For API endpoints, we use Nitro: https://nitro.unjs.io/ to create a custom API server. ## Development @@ -11,10 +12,7 @@ pnpm install ``` ```sh -# Start docs dev server -pnpm docs:dev - -# Start api dev server +# Start dev server pnpm dev ``` @@ -22,12 +20,7 @@ pnpm dev ```sh # Build docs -pnpm docs:build -``` - -```sh -# Build api -pnpm build:api +pnpm build ``` ## Components diff --git a/docs/nitro.config.ts b/docs/nitro.config.ts index 68f750a30..259b9f2e3 100644 --- a/docs/nitro.config.ts +++ b/docs/nitro.config.ts @@ -3,7 +3,8 @@ import { defineNitroConfig } from 'nitropack/config'; export default defineNitroConfig({ compatibilityDate: '2026-02-26', preset: 'vercel', - srcDir: '.vitepress', + srcDir: '.', + apiDir: 'api', routeRules: { '/api/**': { cors: false }, }, diff --git a/docs/package.json b/docs/package.json index 9f940333d..e50b7b8a9 100644 --- a/docs/package.json +++ b/docs/package.json @@ -5,7 +5,7 @@ "type": "module", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", - "docs:dev": "pnpm run /^prebuild:.*/ && vitepress dev", + "dev": "pnpm run /^prebuild:.*/ && vitepress dev", "docs:build": "pnpm run /^prebuild:.*/ && vitepress build", "docs:preview": "vitepress preview", "build:docs": "vitepress build", @@ -17,7 +17,7 @@ "prebuild:iconDetails": "node ./scripts/writeIconDetails.mjs", "prebuild:brandStopwords": "node ./scripts/writeBrandStopwords.mjs", "postbuild:vercelJson": "node ./scripts/writeVercelOutput.mjs", - "dev": "pnpm nitropack dev", + "dev:api": "pnpm nitropack dev", "prebuild:api": "pnpm nitropack prepare", "build:api": "pnpm nitropack build", "build": "pnpm run /^prebuild:.*/ && pnpm run build:api && pnpm run build:docs && pnpm postbuild:vercelJson", @@ -61,4 +61,4 @@ "svgson": "^5.3.1", "vue": "^3.5.24" } -} +} \ No newline at end of file