Dora Factory Documentation
Home · Twitter · Discord

Links

• Stable (main)：https://docs.dorafactory.org
• Canary Preview (develop)：https://df-docs.vercel.app

Conventions

• Versioning: Semantic Versioning 2.0.0
• Git workflow: Gitflow
• Commit message format: Conventional Commits
• Changelog format: Keep a Changelog

Development

The documentation site is powered by Nextra. This repo uses PNPM as the package manager.

Installation

pnpm install

Running the development server

pnpm dev

Building for production

pnpm build

Lint & Prettier

This repo uses ESLint to handle JavaScript and TypeScript code quality, and uses Prettier to format most of the code style.

# ESLint
pnpm lint

# Check code style by Prettier
pnpm prettier

# Format & overwrite code style by Prettier
pnpm prettier:write

Deployments

Dependencies

The Open Graph image generation API /api/og, which uses @vercel/og library, may be dependent on Vercel Edge Functions.

Stable

The Stable version of the documentation corresponds to the main branch.

Canary Preview

The Canary Preview version corresponds to the develop branch, which is deployed via Vercel.