CtrlK
BlogDocsLog inGet started
Tessl Logo

tessl/npm-dumi

Documentation generator for React component libraries with live demos, API tables, and theming support

Pending

Quality

Pending

Does it follow best practices?

Impact

Pending

No eval scenarios have been run

Overview
Eval results
Files

cli.mddocs/

CLI Commands

Command-line interface providing development, build, and setup commands for dumi projects.

Capabilities

Development Server

Start a development server with hot reloading for documentation development.

dumi dev

Usage:

# Start development server on default port
dumi dev

# The development server will:
# - Watch for file changes and hot reload
# - Serve documentation site locally
# - Generate component demos and API tables
# - Enable live editing of code examples

Production Build

Build the documentation site for production deployment.

dumi build

Usage:

# Build for production
dumi build

# Output:
# - Generated static files in dist/ directory
# - Optimized assets and bundles
# - Static HTML for all documentation pages
# - Component demos as separate chunks

Project Setup

Initialize a new dumi project or configure an existing project.

dumi setup

Usage:

# Initialize dumi in current directory
dumi setup

# This command will:
# - Create necessary configuration files
# - Set up basic project structure
# - Install required dependencies
# - Generate sample documentation files

CLI Options

Version Information

Display version information for the dumi CLI.

dumi --version
dumi -v

Help Information

Display help information and available commands.

dumi --help
dumi -h

Environment Variables

The CLI respects several environment variables for configuration:

# Disable caching
DUMI_CACHE=none dumi dev

# Set custom presets
DUMI_PRESETS=preset1,preset2 dumi build

# Set app root directory
APP_ROOT=/path/to/app dumi dev

Command Workflow

Typical development workflow with dumi CLI:

# 1. Initialize new project
dumi setup

# 2. Start development
dumi dev

# 3. Build for production
dumi build

Integration with Build Tools

Dumi CLI can be integrated with package.json scripts:

{
  "scripts": {
    "dev": "dumi dev",
    "build": "dumi build",
    "setup": "dumi setup"
  }
}

Install with Tessl CLI

npx tessl i tessl/npm-dumi

docs

cli.md

configuration.md

index.md

plugins.md

theme-api.md

utilities.md

tile.json