Back to Prisma

Prisma Documentation

README.md

latest2.5 KB
Original Source

Prisma Documentation

This repository is a pnpm monorepo containing the Prisma documentation, blog, design system docs, and shared packages.

Repository structure

PathDescription
apps/docsPrisma documentation site (Next.js + Fumadocs)
apps/blogPrisma blog
apps/eclipseEclipse design system documentation
packages/eclipseEclipse design system component library (@prisma/eclipse)
packages/uiShared UI components and utilities (@prisma-docs/ui)

See each app’s README.md for more detail.

Contributing

New contributors are welcome. Read the contributing guide before submitting changes.

Run locally

From the repository root:

bash
pnpm install
pnpm dev

This starts all apps via Turbo:

To run a single app:

bash
pnpm --filter docs dev      # docs only
pnpm --filter blog dev      # blog only
pnpm --filter eclipse dev   # eclipse design system docs only

Build

bash
pnpm build

To build and serve the docs site:

bash
pnpm --filter docs build
pnpm --filter docs start

Scripts

ScriptDescription
pnpm lint:linksValidate internal and external links (docs)
pnpm lint:codeLint code blocks in MDX (docs)
pnpm lint:spellcheckSpell-check content (docs)
pnpm checkRun formatting and lint fixes across all workspaces

Content

  • Docsapps/docs/content/docs/ (latest), apps/docs/content/docs.v6/ (versioned). Sidebar structure comes from meta.json in each folder. See Fumadocs collections.
  • Blogapps/blog/content/blog/ (MDX with authors, dates, hero images).
  • Eclipseapps/eclipse/content/design-system/ (component docs).

Note on formatting

.md and .mdx files are not formatted by Prettier because they use MDX 3, which Prettier does not support. See prettier/prettier#12209.