Skip to content

README.md

Latest commit

 

History

History
56 lines (44 loc) · 1.91 KB

README.md

File metadata and controls

56 lines (44 loc) · 1.91 KB
Raw

mdbase.dev

Product website and developer documentation for mdbase, mdbase Connect, the runtime profiles, and conforming implementations.

Local development

pnpm install
pnpm sync:sources
pnpm dev

The source synchronizer reads sibling checkouts of mdbase-spec, mdbase-connect, mdbase-contracts, mdbase-rs, and mdbase by default. Override their paths with MDBASE_SPEC_DIR, MDBASE_CONNECT_DIR, MDBASE_CONTRACTS_DIR, MDBASE_RS_DIR, and MDBASE_TS_DIR.

Production build

pnpm sync:sources
pnpm check
pnpm build
(cd ../mdbase-spec/site && npm ci && npm run build)
pnpm import:spec
pnpm check:links

The website repository owns the ecosystem pages and deployment cadence. The normative specification is built by mdbase-spec and imported under /spec/. Connect schemas, theme roles, the homepage particle field, and implementation claims are synchronized from their canonical repositories. Generated assets remain traceable to the release artifacts they document.

The first-party contract catalog is built from the commit pinned in site-sources.json, then published as static files under /contracts/.

Development deployment

pnpm dlx wrangler@4.120.0 login # first use only
pnpm deploy:dev

The command builds the current working tree for https://mdbase-dev.pages.dev, imports the specification, checks local links, and deploys the main branch of the standalone mdbase-dev Cloudflare Pages project. It verifies the live homepage, specification, canonical URLs, and indexing controls after deployment. The production GitHub Pages deployment and mdbase.dev domain are unchanged.

The command uses the existing mdbase-dev Cloudflare Pages project, whose production branch remains main. The sibling mdbase-spec/site/dist build is required, as it is for a local production build; MDBASE_SPEC_DIR and MDBASE_SPEC_SITE_DIST can point to another prepared checkout or artifact.