https://github.com/developer-mike/obsidian-docxer

🚀 Boost your productivity by previewing and converting Word files easily to markdown.
https://github.com/developer-mike/obsidian-docxer

obsidian obsidian-md obsidian-plugin obsidian-plugins

Last synced: about 1 year ago
JSON representation

🚀 Boost your productivity by previewing and converting Word files easily to markdown.

• Host: GitHub
• URL: https://github.com/developer-mike/obsidian-docxer
• Owner: Developer-Mike
• License: gpl-3.0
• Created: 2024-01-10T14:51:32.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-03-13T17:04:04.000Z (about 1 year ago)
• Last Synced: 2025-03-25T08:42:38.537Z (about 1 year ago)
• Topics: obsidian, obsidian-md, obsidian-plugin, obsidian-plugins
• Language: TypeScript
• Homepage:
• Size: 731 KB
• Stars: 64
• Watchers: 1
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


    

        

        

    



	Docxer for Obsidian.md





    

    

    

    


	

    

    



    🚀 Boost your productivity by previewing and converting Word files easily to markdown.



## Installation

Open the Community Plugins tab in the settings and search for "Docxer" (or click [here](https://obsidian.md/plugins?id=docxer)).

    Other installation methods

    


    


        
Install it using BRAT



        
Manual folder creation

            


                
Create a folder named obsidian-docxer in your vault's plugins folder (<vault>/.obsidian/plugins/).

                
Download main.js, styles.css and manifest.json from the latest release and put them in the obsidian-docxer folder.

                
Enable the plugin in Settings -> Community plugins -> Installed plugins

            

        

    


## Usage

1. Add a .docx file to your vault.

2. Open the file in Obsidian.

3. Click the "Convert" button in the top right corner of the editor to convert the file to markdown.

## Support

Please consider supporting the plugin. The two easiest ways to support the plugin are either by starring ⭐ the repository or by donating any amount on [Ko-fi](https://ko-fi.com/X8X27IA08) ❤️. Thank you!

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/X8X27IA08)

## Implementation

Docxer uses [docx-preview](https://www.npmjs.com/package/docx-preview) to render the previews, [mammoth](https://www.npmjs.com/package/mammoth) to convert `docx` to `HTML` and [turndown](https://www.npmjs.com/package/turndown) to finally convert the `HTML` to Markdown.

## Screenshots

![Docx Preview](assets/docx-preview.png)

![Converted File](assets/converted-file.png)

## Contributing

All contributions are welcome! Here's how you can help:

- Create a fork of the repository

- Create a branch with a descriptive name

- Make your changes

- Debug the plugin using `npm run dev`

- Create a pull request

- Wait for the review