README file from
GithubOffice Suite for Obsidian
Office Suite is a powerful, all-in-one productivity plugin for Obsidian that lets you view and edit Microsoft Word (.docx), Microsoft Excel (.xlsx), and tabular data files (.csv, .tsv) natively inside your Obsidian interface.
No external applications, no converting your files to Markdown, and no loss of formatting. Edit your documents and spreadsheets side-by-side with your knowledge vault, with full autosave round-tripped directly back to the original binary files.
Key Highlights
- Native Word (.docx) Editor: Full WYSIWYG rich-text editing with true OOXML lossless round-tripping.
- Native Spreadsheet (.xlsx, .csv, .tsv) Editor: Interactive multi-sheet grid interface with formula engine and number formatting.
- Adaptive Theme Support: Toggle between Obsidian Dark Paper mode and true White Paper mode for optimal readability.
- Instant Debounced Autosave: Changes write straight to your vault files on disk without interrupting your writing flow.
- 100% Local & Privacy-First: Everything runs locally inside your Obsidian workspace. No cloud services or external dependencies required.
Comprehensive Feature Matrix
1. Word Document Editor (.docx)
Edit standard .docx files generated by Microsoft Word, LibreOffice, or Google Docs with true round-trip fidelity.
| Category | Supported Features |
|---|---|
| Typography & Fonts | Custom font families (Calibri, Arial, Times New Roman, Georgia, Courier New, Verdana, Segoe UI, Trebuchet MS, Tahoma), font sizes (8pt – 72pt), Clear Formatting |
| Rich Text Styling | Bold, Italic, Underline, Inline Code, Blockquotes |
| Colors | Text color picker with custom HEX selector, Background highlight color picker |
| Headings & Structure | Full heading hierarchy (H1 – H6) mapped 1:1 to Word styles, Paragraphs, Horizontal Dividers, Page Breaks (Ctrl+Enter) |
| Paragraph & Alignment | Left, Center, Right, and Justified alignment; customizable line spacing (1.0, 1.15, 1.5, 2.0); Indent & Outdent controls |
| Lists | Bulleted lists, Numbered / Ordered lists, Nested list indentation and lift controls |
| Tables | Insert custom tables, Add Row Above / Below, Add Column Left / Right, Delete Row / Column / Table, Custom Cell Shading (Blue, Gray, Yellow, Green, Clear) |
| Images & Media | Embedded document images, interactive resize handles with aspect-ratio locking, alignment presets (Left, Center, Right), dimension tooltips |
| Preservation Engine | Unedited OOXML elements (headers, footers, styles.xml, numbering.xml, themes, and page margins) are preserved intact |
2. Spreadsheet & Data Editor (.xlsx, .csv, .tsv)
View, edit, calculate, and format Excel spreadsheets and tabular files seamlessly inside your notes.
| Category | Supported Features |
|---|---|
| Grid Engine | Smooth spreadsheet grid with row/column headers, active cell cursor, range selection, and keyboard navigation |
| Formula Engine | Real-time calculation with =SUM(), =AVERAGE(), =COUNT(), =MAX(), =MIN(), =IF(), =CONCAT(), =ROUND(), and algebraic expressions |
| Formula Bar | Dedicated formula bar showing current cell coordinate (e.g., A1, C12) with full interactive formula editing |
| Number Formatting | Quick Currency format ($), Percentage format (%), Increase decimal places (.00), Decrease decimal places (.0) |
| Cell Typography | Font family selector, font size controls, Bold, Italic, Underline, |
| Cell Styling & Colors | Text color palette, Cell background / fill color picker, Cell border toggling |
| Cell Alignment | Left align (text default), Center align, Right align (numeric default) |
| Row & Column Controls | Insert row below, Insert column right, Delete selected row, Delete selected column |
| Multi-Sheet Workbooks | Workbook tab bar: switch sheets, create new sheet (+), and double-click to rename sheet tabs |
| CSV & TSV Support | Native parsing and serialization of comma-separated and tab-separated files with full grid capabilities |
| History Stack | Full undo (Ctrl+Z) and redo (Ctrl+Y) history stack for spreadsheet edits |
Installation
Method 1: Obsidian Community Plugins (Recommended)
Once listed in the official Obsidian Community Plugins directory:
- Open Obsidian Settings.
- Navigate to Community plugins and ensure Restricted mode is turned off.
- Click Browse and search for "Office Suite".
- Click Install, then click Enable.
- Open any
.docx,.xlsx,.csv, or.tsvfile from your file explorer to start editing!
Method 2: Beta Testing via Obsidian BRAT
You can test the latest beta releases using the Obsidian BRAT plugin:
- Install BRAT from Community Plugins.
- Open Settings → BRAT → Add Beta plugin.
- Paste the repository URL:
https://github.com/vishalrashmika/obsidian-office-suite. - Click Add Plugin and enable Office Suite.
Method 3: Manual Installation
- Download
manifest.json,main.js, andstyles.cssfrom the latest release. - Open your Obsidian Vault folder in your file manager.
- Navigate to
.obsidian/plugins/(create the folder if it doesn't exist). - Create a new folder named
office-suite(ordocx-editor). - Copy
manifest.json,main.js, andstyles.cssinto that folder. - In Obsidian, go to Settings → Community plugins and enable Office Suite.
Quick Start Guide
- Opening Files: Simply click on any
.docx,.xlsx,.csv, or.tsvfile in your Obsidian vault. The file opens immediately in the Office Suite editor. - Switching Paper Themes: Use the Paper Theme toggle in the top-right toolbar to switch between Light Mode (white page paper) and Dark Mode (dark page paper).
- Inserting Tables & Images: In
.docxmode, click the Table dropdown or Image button in the toolbar to add media and structured data. - Entering Formulas: In
.xlsxor.csvmode, select a cell, type=in the Formula Bar, and use standard spreadsheet formulas like=SUM(A1:A10)or=AVERAGE(B1:B5). - Autosaving: All modifications autosave automatically in the background (~800ms debounce). You can verify save status via the "Saved" indicator in the toolbar.
Shortcuts and Hotkeys
| Action | Shortcut |
|---|---|
| Undo | Ctrl + Z / Cmd + Z |
| Redo | Ctrl + Y / Cmd + Shift + Z |
| Bold | Ctrl + B / Cmd + B |
| Italic | Ctrl + I / Cmd + I |
| Underline | Ctrl + U / Cmd + U |
| Edit Cell (Spreadsheet) | F2 |
| Page Break (Docx) | Ctrl + Enter / Cmd + Enter |
Contributing
Contributions, feature requests, and bug reports are welcome! We want to make Office Suite the premier document and data tool for the Obsidian ecosystem.
How to Contribute
- Report a Bug / Request a Feature: Open an Issue on GitHub with detailed reproduction steps or feature descriptions.
- Submit a Pull Request:
- Fork the repository.
- Create a feature branch (
git checkout -b feature/amazing-feature). - Commit your changes (
git commit -m 'Add amazing feature'). - Push to your branch (
git push origin feature/amazing-feature). - Open a Pull Request.
Development Setup
# Clone the repository
git clone https://github.com/vishalrashmika/obsidian-office-suite.git
cd obsidian-office-suite
# Install dependencies
npm install
# Start development build with watch mode
npm run dev
# Build production bundle
npm run build
Support the Project
If you find Office Suite valuable for your daily note-taking and workflow, please consider supporting its continuous development:
Your support helps cover development tools, test devices, and future feature expansions! Don't forget to star the repository on GitHub!
Author
Created by Vishal Rashmika.
License
This project is licensed under the GPL V3.