⚠️ Warning: This project is not yet stable and may undergo significant changes before reaching version 1.0.0. We strongly advise against using it in production environments.

Docen

Universal document format converter providing seamless transformation between Markdown, HTML, and DOCX formats. Built on TipTap/ProseMirror with comprehensive TypeScript support.

Packages

• docen - Universal document converter with unified API for Markdown, HTML, and DOCX transformations
• @docen/extensions - Comprehensive TipTap extension collection with full TypeScript types
• @docen/export-docx - Export TipTap/ProseMirror content to Microsoft Word DOCX format
• @docen/import-docx - Import Microsoft Word DOCX files to TipTap/ProseMirror content
• @docen/deduplicate - Document deduplication and similarity analysis utilities

Quick Start

Universal Format Converter (Recommended)

For seamless conversion between Markdown, HTML, and DOCX formats, use the unified docen package:

# Install with npm
$ npm install docen

# Install with yarn
$ yarn add docen

# Install with pnpm
$ pnpm add docen

import { parseHTML, generateDOCX, parseMarkdown } from "docen";

// HTML → DOCX
const doc = parseHTML("<h1>Title</h1><p>Hello World</p>");
const docx = await generateDOCX(doc, { outputType: "nodebuffer" });

// Markdown → HTML
const doc2 = parseMarkdown("# Title\n\nHello World");
const html = generateHTML(doc2);

Individual Format Packages

DOCX Export

$ npm install @docen/export-docx

import { generateDOCX } from "@docen/export-docx";
import { writeFileSync } from "node:fs";

const content = {
  type: "doc",
  content: [
    {
      type: "paragraph",
      content: [
        {
          type: "text",
          marks: [{ type: "bold" }, { type: "italic" }],
          text: "Hello, world!",
        },
      ],
    },
  ],
};

const docx = await generateDOCX(content, { outputType: "nodebuffer" });
writeFileSync("document.docx", docx);

DOCX Import

$ npm install @docen/import-docx

import { parseDOCX } from "@docen/import-docx";
import { readFileSync } from "node:fs";

// Read DOCX file
const buffer = readFileSync("document.docx");

// Parse DOCX to TipTap JSON
const content = await parseDOCX(buffer);

// Use in TipTap editor
editor.commands.setContent(content);

Development

Prerequisites

• Node.js 18.x or higher
• pnpm 9.x or higher (recommended package manager)
• Git for version control

Getting Started

1. Clone the repository:

   git clone https://github.com/DemoMacro/docen.git
   cd docen

2. Install dependencies:

   pnpm install

3. Development mode:

   pnpm dev

4. Build all packages:

   pnpm build

5. Test locally:

   # Link the package globally for testing
   cd packages/export-docx
   pnpm link --global
   
   # Test in your project
   import { generateDOCX } from '@docen/export-docx';

Development Commands

pnpm dev            # Development mode with watch
pnpm build          # Build all packages
pnpm lint           # Run code formatting and linting

Contributing

We welcome contributions! Here's how to get started:

Quick Setup

1. Fork the repository on GitHub

2. Clone your fork:

   git clone https://github.com/YOUR_USERNAME/docen.git
   cd docen

3. Add upstream remote:

   git remote add upstream https://github.com/DemoMacro/docen.git

4. Install dependencies:

   pnpm install

5. Development mode:

   pnpm dev

6. Test locally:

   # Link the package globally for testing
   cd packages/export-docx
   pnpm link --global
   
   # Test your changes
   import { generateDOCX } from '@docen/export-docx';

Development Workflow

1. Code: Follow our project standards
2. Test: pnpm build && <test your extension>
3. Commit: Use conventional commits (feat:, fix:, etc.)
4. Push: Push to your fork
5. Submit: Create a Pull Request to upstream repository

Project Philosophy

This project follows core principles:

1. TipTap Focus: Built specifically for TipTap/ProseMirror ecosystem
2. Type Safety: Full TypeScript support with comprehensive types
3. Modular Design: Each converter handles specific content types
4. Extensible: Easy to add new content type converters
5. Performance: Optimized for large documents and batch processing
6. User Experience: Simple API with powerful configuration options

Support & Community

• 📫 Report Issues
• 📚 Export Documentation
• 📚 Import Documentation

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Built with ❤️ by Demo Macro