EERP Suite

Clearify Setup

Clearify is the documentation site generator that powers this site. Here's how to use it in your own project.

Installation

npm install clearify --save-dev

Scaffold a New Docs Site

npx clearify init

This creates:

  • docs/public/index.md — home page
  • docs/public/getting-started.md — starter guide
  • docs/internal/index.md — internal docs (draft, excluded from production builds)
  • clearify.config.ts — project configuration
  • CHANGELOG.md — auto-rendered at /changelog

Development

npx clearify dev

Opens at http://localhost:4747 with hot-reload. Every .md or .mdx file in docs/public/ becomes a page.

Configuration

// clearify.config.ts
import { defineConfig } from 'clearify';

export default defineConfig({
  name: 'My Project',
  sections: [
    { label: 'Docs', docsDir: './docs/public' },
    { label: 'Internal', docsDir: './docs/internal', basePath: '/internal', draft: true },
  ],
  mermaid: {
    strategy: 'build', // Render Mermaid diagrams at build time
  },
});

Build for Production

npx clearify build

Outputs a static site to docs-dist/ with pre-rendered pages, sitemap.xml, and robots.txt. Deploy anywhere that serves static files.

Next Steps

For full documentation, see the Clearify project docs.