Skip to content

deathau/csv-obsidian

Repository files navigation

CSV Editor Obsidian Plugin

GitHub release (latest SemVer) GitHub All Releases

A plugin for Obsidian which allows viewing and editing of CSV files in a spreadsheet-like table format.

Back up your CSV files! This plugin is very new and therefore experimental. At this stage, data loss is a very real possibility!

Screenshot

Features

  • Open (and edit) CSV files right from Obsidian!
  • Auto-saving
  • Per-file setting for including headers (persisted in local storage)
  • Markdown editing an preview for each individual cell (internal links aren't working correctly, yet)
  • Sort the data by clicking on a column name
  • Filter by column values
  • Freeze columns
  • Insert new columns/rows

Installation

From GitHub

  • Download the latest master
  • Extract the files from the zip to your vault's plugins folder: <vault>/.obsidian/plugins/ini-obsidian
    Note: On some machines the .obsidian folder may be hidden. On MacOS you should be able to press Command+Shift+Dot to show the folder in Finder.
  • Reload Obsidian
  • If prompted about Safe Mode, you can disable safe mode and enable the plugin. Otherwise head to Settings, third-party plugins, make sure safe mode is off and enable the plugin from there.

Development

This project uses Typescript to provide type checking and documentation.
The repo depends on the latest plugin API in Typescript Definition format, which contains TSDoc comments describing what it does.

Note: The Obsidian API is still in early alpha and is subject to change at any time!

If you want to contribute to development and/or just customize it with your own tweaks, you can do the following:

  • Clone this repo.
  • npm i or yarn to install dependencies
  • npm run build to compile.
  • Copy manifest.json, main.js and styles.css to a subfolder of your plugins folder (e.g, <vault>/.obsidian/plugins/<plugin-name>/)
  • Reload obsidian to see changes

Alternately, you can clone the repo directly into your plugins folder and once dependencies are installed use npm run dev to start compilation in watch mode.
You may have to reload obsidian (ctrl+R) to see changes.

Pricing

Huh? This is an open-source plugin I made for fun. It's completely free. However, if you absolutely have to send me money because you like it that much, feel free to throw some coins in my hat via PayPal or sponsor me via GitHub Sponsors

Version History

0.0.1

Initial release of csv-obsidian! See Features above