Local Development

Clearify is designed to be used across multiple standalone projects. Since there is no shared monorepo workspace, npm link is the recommended way to use a local build of Clearify in other projects.

Building Clearify

First, build and link Clearify globally:

cd projects/clearify
npm run build
npm link

This makes the clearify package available globally on your machine.

Using in another project

In the project where you want to use Clearify:

cd projects/data-table
npm link clearify

Now you can create a docs/ folder and run the dev server:

mkdir -p docs
echo "# Data Table Docs" > docs/index.md
npx clearify dev

The dev server starts at http://localhost:4747. The header will automatically show the project name from package.json.

Configuration

Create a clearify.config.ts in the project root to customize behavior:

import { defineConfig } from '@marlinjai/clearify';

export default defineConfig({
  name: 'Data Table',
  exclude: ['ROADMAP.md', '**/design-*.md'],
});

Unlinking

To remove the link when you're done:

cd projects/data-table
npm unlink clearify

Rebuilding after changes

After making changes to Clearify itself, rebuild before testing:

cd projects/clearify
npm run build

The link persists across rebuilds — no need to re-link.