yashgo0018 / df-docs Goto Github PK

Dora Factory Documentation
Home · Twitter · Discord

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

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

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

pnpm install

pnpm dev

pnpm build

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

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

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

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