marketing-site-private

This is a package that contains Redocly marketing site marketing pages as React components.

It is published to NPM as @redocly/marketing-pages. The code is minified.

Development

Local development against the website repo uses yalc instead of npm link. yalc copies the built package into the website like a real npm install, so react, styled-components, @redocly/theme, etc. resolve from the website's own node_modules — no duplicate-React/broken-symlink problems.

One-time setup

1. In this package: pnpm install, then pnpm run yalc:publish (full build + publish to the local yalc store).
2. In the website repo: npm run link-marketing-pages (rewrites the @redocly/marketing-pages dependency to link:.yalc/... and symlinks it into node_modules — this change must not be committed; .yalc/ and yalc.lock are gitignored).

Daily workflow (2 terminals)

1. Here: pnpm run yalc:watch — runs tsgo --watch, re-copies images on change, and yalc pushes dist/ to the website on every rebuild (~1s debounce).
2. Website repo: npm start.

Notes:

• The watch loop skips minification (tools/minify.js) — dev output is unminified. Run pnpm run yalc:publish for a full production-like build.

• ⚠️ Never run npm install in the website while linked. The yalc-copied package.json still contains catalog: version specifiers that npm can't resolve. Safe sequence:

  npm run unlink-marketing-pages   # restores the registry version in package.json
  npm install                      # do whatever you need
  npm run link-marketing-pages     # relink

Tear down

In the website repo: npm run unlink-marketing-pages && npm install.

Release

Versioning and npm releases use Changesets. Run everything from the monorepo root (not from this package directory).

1. Add a changeset — Run pnpm changeset (or pnpm run changeset:common). When prompted, include @redocly/marketing-pages if the change should be released. Commit the generated file under .changeset/.
2. Open a PR to main — Merge your work together with that changeset.
3. Version PR — After merge, release automation opens a PR that applies version bumps and changelog updates from the changesets.
4. Publish — Merging the version PR runs CI to publish the new version to npm.