README.md

office.yazi

A plugin to preview office documents in Yazi

Installation

Tip

Installing this plugin with ya will conveniently clone the plugin from GitHub, copy it to your plugins directory, and update the package.toml to lock its version ¹.

To install it with ya run:

ya pack -a macydnah/office

Or if you prefer a manual approach:

## For linux and MacOS
git clone https://github.com/macydnah/office.yazi.git ~/.config/yazi/plugins/office.yazi

## For Windows
git clone https://github.com/macydnah/office.yazi.git %AppData%\yazi\config\plugins\office.yazi

Usage

In your yazi.toml add rules to preloaders² and previewers³ to run office plugin with office documents.

Note

Your config may be different depending if you're appending, prepending or overriding default rules. If unsure, take a look at Configuration⁴ and Configuration mixing⁵

For a general usecase, you may use the following rules

[plugin]

prepend_preloaders = [
    # Office Documents
    { mime = "application/vnd.openxmlformats-officedocument.*", run = "office" },
    { mime = "application/vnd.oasis.opendocument.*", run = "office" },
    { mime = "application/vnd.ms-*", run = "office" },
    { mime = "application/msword", run = "office" },
    { name = "*.docx", run = "office" },
]

prepend_previewers = [
    # Office Documents
    { mime = "application/vnd.openxmlformats-officedocument.*", run = "office" },
    { mime = "application/vnd.oasis.opendocument.*", run = "office" },
    { mime = "application/vnd.ms-*", run = "office" },
    { mime = "application/msword", run = "office" },
    { name = "*.docx", run = "office" },
]

Dependencies

Important

Make sure that these commands are installed in your system and can be found in PATH:

• libreoffice
• pdftoppm

License

office.yazi is licensed under the terms of the MIT License

Footnotes

1. The official package manager for Yazi ↩

2. Preloaders rules ↩

3. Previewers rules ↩

4. Configuration ↩

5. Configuration mixing ↩