Getting Started

Prerequisites

• Node.js >= 18
• pnpm >= 9

Installation

Clone the Repository

git clone https://github.com/YunYouJun/starter-monorepo.git
cd starter-monorepo

Install Dependencies

pnpm install

Project Structure

starter-monorepo/
├── docs/                   # Documentation site
│   ├── .vitepress/        # VitePress config
│   ├── guide/             # Guide docs
│   ├── api/               # API docs (auto-generated)
│   └── public/            # Static assets
├── packages/
│   └── pkg-placeholder/   # Example package
│       ├── src/           # Source code
│       ├── test/          # Tests
│       └── dist/          # Build output
├── package.json           # Root package.json
├── pnpm-workspace.yaml    # pnpm workspace config
└── tsconfig.json          # TypeScript config

Development

Build All Packages

pnpm build

Run in Development Mode

pnpm dev

Run Tests

pnpm test

Type Check

pnpm typecheck

Lint Code

pnpm lint

Working with Documentation

Start Documentation Site

pnpm docs:dev

Visit http://localhost:5173 to view the documentation.

Generate API Documentation

pnpm docs:api

This will:

1. Read source code from packages/*/src
2. Parse JSDoc comments and TypeScript types
3. Generate Markdown docs in docs/api/

Build Documentation

pnpm docs:build

Preview Built Documentation

pnpm docs:preview

Creating a New Package

1. Create a new directory in packages/:

mkdir packages/my-package
cd packages/my-package

2. Initialize package.json:

{
  "name": "my-package",
  "version": "0.0.0",
  "type": "module",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.mjs"
    }
  },
  "main": "./dist/index.mjs",
  "types": "./dist/index.d.ts",
  "files": ["dist"]
}

3. Create source files:

mkdir src
echo "export const hello = 'world'" > src/index.ts

4. Add build config (build.config.ts):

import { defineBuildConfig } from 'unbuild'

export default defineBuildConfig({
  entries: ['src/index'],
  declaration: true,
  clean: true,
  rollup: {
    emitCJS: false,
  },
})

Next Steps

• Learn about Configuration
• Explore the API Reference
• Read the Changelog