A high-performance, open-source document editor built on Lexical.

⚠️ HawkDoc is currently in MVP stage. Feedback and contributions are welcome.

🚧 Latest changes are on the dev branch and not yet merged to main.

UI is actively being improved. This is the current MVP version.

HawkDoc is a document editor focused on performance and template rendering. It is built on Lexical — Meta's editor framework — and designed to handle large documents, dynamic template variables, and document export without blocking the UI.

The project is currently MVP stage. The core editor is functional. The collaboration layer, auth, and DOCX pipeline are planned.

• Lexical editor with block types: H1, H2, H3, paragraph, bullet list, ordered list, code block, quote, divider
• Slash / command menu with keyboard navigation
• Formatting toolbar: Bold, Italic, Underline, Strikethrough, inline code, link
• Floating bubble menu on text selection
• Template variable injection — type {{variable_name}} to insert a styled placeholder chip
• PDF export with watermark (via the Export menu in the toolbar)
• Markdown and HTML export
• Auto-save with 800ms debounce
• Editable document title
• Code block with copy-to-clipboard

git clone https://github.com/hawk-doc/hawkdoc.git
cd hawkdoc

# Start PostgreSQL and Redis
docker compose up -d

# Install and run
npm install
npm run dev

Frontend: http://localhost:5173 - API: http://localhost:3001

Copy .env.example to .env in both apps/web and apps/api and fill in the values before starting.

The UI is intentionally minimal at this stage. Design improvements will come later.

• Real-time collaboration (Hocuspocus + Yjs)
• User auth (JWT)
• Document list and workspace
• DOCX import/export
• Version history
• Image upload support

Contributions are welcome. Please read CONTRIBUTING.md before opening a PR.

• All PRs target the dev branch
• Follow Conventional Commits
• Look for good first issue labels to get started

MIT © HawkDoc Contributors