open-index/open-npm huggingface dataset:
npm package: @mysten-docs/create-docusaurus-site
Description: CLI tool to create new Docusaurus sites with shared components and themes
Latest version: 0.1.3

# @mystenlabs/create-docusaurus-site

A CLI tool to create new Docusaurus sites with Mysten Labs shared components, plugins, and themes.

## Usage

### From the workspace root

```bash
pnpm create-site
```

### When published

```bash
npx @mystenlabs/create-docusaurus-site my-site
```

## Options

```bash
create-mystenlabs-site [site-name] [options]

Arguments:
  site-name                    name of the site to create

Options:
  -t, --template <template>    template to use (basic, blog, docs) (default: "basic")
  -d, --directory <directory>  directory to create site in (relative or absolute path)
  --pm <package-manager>       package manager to use (npm, pnpm, yarn) (default: "pnpm")
  --no-components             skip installing shared components
  --no-plugins                skip installing shared plugins
  --no-themes                 skip installing shared themes
  --local-dev                 use local file references (for unpublished packages)
  -h, --help                  display help for command
```

## Examples

### Create a site in a specific location
```bash
# Create in parent directory (recommended)
pnpm create-site my-docs --directory ../my-docs

# Create in home directory
pnpm create-site my-site --directory ~/projects/my-site

# Create in absolute path
pnpm create-site my-site --directory /Users/username/sites/my-site

# Interactive mode will default to parent directory
pnpm create-site
```

### Quick setup with all options
```bash
pnpm create-site my-docs \
  --directory ~/projects/my-docs \
  --template docs \
  --pm pnpm \
  --no-plugins
```

### For local development (packages not published yet)
```bash
pnpm create-site my-site \
  --directory ../my-site \
  --local-dev
```

## Templates

### Basic
- Simple site with homepage and docs
- Includes shared components showcase
- Minimal configuration

### Blog
- Blog-focused site layout
- Enhanced for content creation
- Includes shared themes

### Docs
- Documentation-focused layout
- All shared packages included
- Advanced configuration

## Features

- 🚀 **Interactive CLI** - Guided setup with prompts
- 📦 **Multiple Templates** - Choose the right starting point
- 🎨 **Shared Components** - Pre-built React components with Tailwind CSS
- 🔧 **Shared Plugins** - Custom Docusaurus plugins
- 🎨 **Shared Themes** - Consistent styling across sites
- 📋 **Package Manager Choice** - Support for npm, pnpm, and yarn

## What's Created

When you create a new site, you get:

- Complete Docusaurus site structure
- Configured `docusaurus.config.js`
- Sample content and documentation
- Shared packages (based on your selection)
- `.npmrc` for GitHub Packages registry
- Ready-to-use development environment

## Development

```bash
# Build the CLI tool
pnpm run build

# Test locally
pnpm create-site
```

## Publishing

This package is published to GitHub Packages as part of the monorepo release process.