TOML Editor

TOML Editor

TOML Editor is an Obsidian plugin that opens .toml files in a native Obsidian pane instead of launching an external editor.

Features

• Native Obsidian file pane for .toml files.
• Code editor behavior powered by CodeMirror 6.
• TOML syntax highlighting.
• Obsidian-style debounced autosave.
• Parse-error status and editor diagnostics.

Usage

Once the plugin is enabled, open any .toml file from Obsidian's file explorer. TOML Editor will open the file in an Obsidian tab with line numbers, syntax highlighting, autosave, and parse diagnostics.

The status bar above the editor shows whether the current document is valid TOML. Parse errors are also shown inline in the editor.

Manual installation

1. Download main.js, manifest.json, and styles.css from the latest release.
2. Create a folder named toml-editor inside your vault's .obsidian/plugins/ directory.
3. Copy the three downloaded files into .obsidian/plugins/toml-editor/.
4. Reload Obsidian and enable TOML Editor from Community plugins.

Development

Install dependencies:

npm install

Run tests:

npm test

Typecheck:

npm run typecheck

Build:

npm run build

Community plugin submission

See docs/community-plugin-submission.md for the release and Obsidian directory submission checklist.

Release

Obsidian community plugin releases must include main.js, manifest.json, and styles.css as individual release assets. The release name and git tag should exactly match the version in manifest.json, without a v prefix.

For version 0.1.0:

git tag 0.1.0
git push origin 0.1.0

The release workflow builds and publishes the required assets automatically.

License

MIT