stardust dev

Start a local development server with live reload for writing documentation.

Usage

bash

stardust dev [options]

bash

stardust dev

Opens your documentation at http://localhost:4000 with:

bash

stardust dev --port 3000

bash

stardust dev --no-open

The dev server watches for changes and automatically refreshes:

💡 Tip

Save your file and the browser refreshes automatically. No manual refresh needed!

When there's a parsing error in your markdown, the dev server shows a helpful overlay with:

Search works during development with a temporary index. For the optimized production index, run stardust build.

Set default dev server options in stardust.yaml:

yaml

dev:
  port: 4000
  host: localhost
  open: true
  watch:
    - docs/
    - public/

By default, Stardust watches docs/ and public/. Add custom directories:

yaml

dev:
  watch:
    - docs/
    - public/
    - examples/

To access from other devices on your network:

bash

stardust dev --host 0.0.0.0

Then access from other devices using your computer's IP address.

Press Ctrl+C in the terminal to stop the development server.

If port 4000 is taken:

bash

stardust dev --port 4001

Or find and kill the process using the port:

bash

# macOS/Linux
lsof -i :4000
kill -9 <PID>

# Windows
netstat -ano | findstr :4000
taskkill /PID <PID> /F

For large documentation sites: