# DOCX Exporter: Obsidian Note Export Plugin

[中文版](README_CN.md)

## Introduction
DOCX Exporter is a plugin designed for Obsidian, aiming to help users easily export note content into DOCX format.

<img width="1403" height="959" alt="截屏2025-12-13 20 47 43" src="https://github.com/user-attachments/assets/d2d5b9af-4f0d-4f62-9c1d-e787d939bb1c" />


The biggest advantage of this plugin is its **zero external dependencies**. It does not require installing additional external tools like Pandoc, allowing it to run seamlessly on all platforms supported by Obsidian (including desktop, mobile, and iPad), providing you with a consistent export experience.

## Key Features
* **Cross-Platform Support**: Works on Windows, macOS, Linux, iOS, and Android without the need for additional software.
* **Rich Text Export**: Supports exporting various Markdown formats, including headings, bold, italics, lists, hyperlinks, and code blocks.
* **Image Support**: Can export local and web images from notes, and automatically handles image formats and dimensions.
* **Compatibility**: The generated DOCX files have good compatibility with Microsoft Word.

## Known Issues and Workarounds
Currently, we have found that when the exported DOCX file is opened with **Apple Pages** or the **system's native Preview app**, the formatting may be incorrect.

* **Cause**: This is typically because these applications cannot correctly handle certain compatibility settings and font metadata within the DOCX file.
* **Workaround**: Simply open the file with **Microsoft Word** (desktop or mobile version) and save it again. Word will automatically fix and add the necessary compatibility information, after which the file can be opened normally in Pages or other applications.

## Installation
You can install the DOCX Exporter directly from the Obsidian Community Plugins market.
* Open Obsidian **Settings**.
* Click **Community plugins**, and then turn off **Safe mode**.
* In the plugin list, search for **"DOCX Exporter"**.
* Click **Install**, then **Enable** the plugin.

## How to Use
1.  Open the note you want to export.
2.  Click the export icon in the left sidebar, or run the command “**Export current note to DOCX**” via the command palette (`Ctrl/Cmd + P`).
3.  The plugin will generate a DOCX file and save it in the same folder as the current note.

## Acknowledgements
This plugin uses the following open-source projects and libraries in its development:

* **[JSZip](https://github.com/Stuk/jszip)**
    * **License:** MIT
    * **Description:** Used for packing and unpacking DOCX files, which are essentially zipped archives.
* **[docx](https://github.com/dolanmiu/docx)**
    * **License:** MIT
    * **Description:** A powerful library for generating DOCX files in pure JavaScript/TypeScript.