` | `\\sqrt[]{}` | Nth roots |\n\n## ๐จ Advanced Usage Examples\n\n### Error Handling\n\n```typescript\nimport { \n OfficeToMarkdown, \n FileConversionException, \n UnsupportedFormatException \n} from '@aidalinfo/office-to-markdown';\n\nasync function convertSafely(filePath: string) {\n try {\n const converter = new OfficeToMarkdown();\n const result = await converter.convertDocx(filePath);\n return result.markdown;\n } catch (error) {\n if (error instanceof UnsupportedFormatException) {\n console.error('Unsupported format:', error.message);\n } else if (error instanceof FileConversionException) {\n console.error('Conversion error:', error.message);\n } else {\n console.error('Unexpected error:', error.message);\n }\n throw error;\n }\n}\n```\n\n### Capability Checking\n\n```typescript\nimport { OfficeToMarkdown } from '@aidalinfo/office-to-markdown';\n\nconst converter = new OfficeToMarkdown();\n\n// Check supported types\nconst info = converter.getSupportedTypes();\nconsole.log('Extensions:', info.extensions); // ['.docx']\nconsole.log('MIME types:', info.mimeTypes);\n\n// Check if a file is supported\nconst isSupported = await converter.isSupported('./document.pdf');\nconsole.log('PDF supported:', isSupported); // false\n\n// Get file information\nconst fileInfo = await converter.getFileInfo('./document.docx');\nconsole.log('MIME type:', fileInfo.mimetype);\nconsole.log('Supported:', fileInfo.supported);\n```\n\n### Usage with Node.js\n\n```typescript\nimport { readFile } from 'fs/promises';\nimport { OfficeToMarkdown } from '@aidalinfo/office-to-markdown';\n\n// From Node.js Buffer\nconst buffer = await readFile('./document.docx');\nconst converter = new OfficeToMarkdown();\nconst result = await converter.convert(buffer);\n\nconsole.log(result.markdown);\n```\n\n## ๐งช Testing and Validation\n\n### Test Results\n\n- โ
HTML โ Markdown conversion with tables\n- โ
File type detection (DOCX vs others)\n- โ
OMML โ LaTeX mathematical conversion\n- โ
Error handling with specific codes\n- โ
Complete pipeline tested with real documents\n\n### Performance\n\n- **Speed**: ~80ms for an average document (7KB)\n- **Fidelity**: Complete preservation of structure and content\n- **Robustness**: Graceful error handling with fallbacks\n\n## ๐ง Development\n\n### Prerequisites\n\n- **Bun** >= 1.2.0 (recommended) or **Node.js** >= 20.0.0\n- **TypeScript** >= 4.5.0\n\n### Development Installation\n\n```bash\ngit clone https://github.com/aidalinfo/extract-kit.git\ncd extract-kit/packages/office-to-markdown\nbun install\n```\n\n### Available Scripts\n\n```bash\nbun run build # Complete build (ESM + types)\nbun run dev # Development mode with watch\nbun run clean # Clean dist/ folder\n```\n\n### Testing\n\n```bash\n# Basic functionality test\nbun run src/test.ts\n\n# Test with real DOCX file\nbun run test-docx.ts \"your-file.docx\"\n```\n\n## ๐ Roadmap\n\n- [ ] **PPT/PPTX format support** - Presentation conversion\n- [ ] **XLS/XLSX format support** - Spreadsheet conversion\n- [ ] **Streaming API** - Large file streaming processing\n- [ ] **Plugin system** - Support for custom converters\n- [ ] **Web interface** - Optional user interface\n- [ ] **Embedded image support** - Image extraction and conversion\n- [ ] **CLI batch mode** - Command-line interface\n\n## ๐ค Contributing\n\nContributions are welcome! Please see our [contribution guide](https://github.com/aidalinfo/extract-kit/blob/main/CONTRIBUTING.md).\n\n### Contribution Process\n\n1. **Fork** the repository\n2. **Create** a feature branch (`git checkout -b feature/amazing-feature`)\n3. **Commit** your changes (`git commit -m 'Add amazing feature'`)\n4. **Push** to the branch (`git push origin feature/amazing-feature`)\n5. **Open** a Pull Request\n\n## ๐ License\n\nThis project is licensed under **MIT** - see the [LICENSE](LICENSE) file for details.\n\n## ๐ Acknowledgments\n\n- Inspired by Microsoft's [MarkItDown](https://github.com/microsoft/markitdown) project\n- Uses [mammoth.js](https://github.com/mwilliamson/mammoth.js) for DOCX โ HTML conversion \n- Uses [turndown](https://github.com/mixmark-io/turndown) for HTML โ Markdown conversion\n- Optimized for [Bun](https://bun.sh/) runtime\n\n## ๐ Support\n\n- **Issues**: [GitHub Issues](https://github.com/aidalinfo/extract-kit/issues)\n- **Documentation**: [GitHub Repository](https://github.com/aidalinfo/extract-kit/tree/main/packages/office-to-markdown)\n- **Email**: contact@aidalinfo.com\n\n---\n\n\n \n**[@aidalinfo/office-to-markdown](https://www.npmjs.com/package/@aidalinfo/office-to-markdown)**\n\n*Simple, fast, and reliable DOCX to Markdown conversion* โก\n\n
","readmeFilename":"README.md"}