Getting Started

This guide helps you bootstrap Xingluo for local development and production builds from scratch.

Requirements

Tip: manage Node versions with fnm or nvm.

Installation

After cloning the repository, install dependencies:

bash
pnpm install

Once dependencies are installed, the reference projects under references/ are automatically excluded from TypeScript compilation and builds (see exclude in tsconfig.json).

Local Development

Start the dev server (defaults to http://localhost:4321/):

bash
pnpm dev

In development mode:

• Drafts and scheduled posts are all visible (for preview); they are filtered only during production builds
• Content collection changes trigger hot reload
• Client-side behaviors (theme toggle, View Transitions, etc.) match production

Type Sync

After modifying content collection schemas or types, run sync to refresh .astro/types.d.ts:

bash
pnpm sync

Build

The production build has three steps (see the build script in package.json):

bash
pnpm build

1. astro check: TypeScript and Astro template type checking; any error aborts the build
2. astro build: statically generates the whole site to dist/ (including dynamic OG images, RSS, sitemap, robots.txt)
3. node scripts/generateSearchIndex.mjs: scans dist/ to generate the full-text search index into dist/search/

Note: The search index is generated by a Node script after the build completes.

Preview the Build

Preview the build output in dist/ locally:

bash
pnpm preview

Code Quality

Next Steps

• Read the Configuration Guide to customize site info and feature toggles
• Read Content Authoring to start writing
• Read Deployment to publish your site