Skip to content

Command Reference

This page provides a comprehensive reference for all commands available in nodecode-docs-astro.

Starts the development server with hot module reloading.

Usage:

Terminal window
bun run dev

Options:

  • --host: Expose server to network (default: localhost)
  • --port: Specify port number (default: 4321)

Builds the documentation site for production deployment.

Usage:

Terminal window
bun run build

Output: Static files in dist/ directory

Preview the production build locally before deployment.

Usage:

Terminal window
bun run preview

Runs TypeScript type checking and Astro diagnostics.

Usage:

Terminal window
bun run check

What it checks:

  • TypeScript type errors
  • Content Collections schema validation
  • Frontmatter validation
  • Component prop types

See the astro.config.mjs file for site configuration options including:

  • Site metadata (title, description)
  • Sidebar navigation structure
  • Custom CSS and theming
  • Integration settings (MDX, Starlight)
CodeMeaning
0Success
1Build error (syntax, type errors, invalid frontmatter)
2Configuration error