Skip to content

Latest commit

 

History

History
62 lines (53 loc) · 3.43 KB

README.md

File metadata and controls

62 lines (53 loc) · 3.43 KB

Logo

Docxer for Obsidian.md

GitHub star count Open issues on GitHub List of contributors
GPL-3.0 license

🚀 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).

Other installation methods
  • Install it using BRAT
  • Manual folder creation
    1. Create a folder named obsidian-docxer in your vault's plugins folder (<vault>/.obsidian/plugins/).
    2. Download main.js, styles.css and manifest.json from the latest release and put them in the obsidian-docxer folder.
    3. 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 ❤️. Thank you!

ko-fi

Implementation

Docxer uses docx-preview to render the previews, mammoth to convert docx to HTML and turndown to finally convert the HTML to Markdown.

Screenshots

Docx Preview Converted File

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