https://github.com/situ2001/obsidian-editor-group-arrangement

Arrange the editor group of Obsidian in a more flexible way
https://github.com/situ2001/obsidian-editor-group-arrangement

editor obsidian obsidian-plugin plugin

Last synced: 8 months ago
JSON representation

Arrange the editor group of Obsidian in a more flexible way

• Host: GitHub
• URL: https://github.com/situ2001/obsidian-editor-group-arrangement
• Owner: situ2001
• License: mit
• Created: 2025-02-05T05:57:24.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2025-02-09T15:34:10.000Z (8 months ago)
• Last Synced: 2025-02-09T16:22:44.365Z (8 months ago)
• Topics: editor, obsidian, obsidian-plugin, plugin
• Language: TypeScript
• Homepage:
• Size: 3.21 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# obsidian-editor-group-arrangement

> Arrange your editor group in a more flexible way.

![screenshots](./screen-recording.gif)

## Introduction

This is a plugin for [Obsidian](https://obsidian.md/), which provides a way to arrange the editor group in a more flexible way. Currently, the plugin supports the following features:

- Arrange action

  - Arrange evenly: this action will arrange the editor group evenly.

  - Expand active editor: this action will expand the active editor, and shrink the other editors to the minimum size. Just like what vscode does.

- Arrange Mode

  - Manual: Do nothing.

  - Auto Expand: Automatically expand the active editor when the active editor is changed or when you click on the editor tab.

## How to use

1. Install and enable the plugin.

2. Then you can make actions and switch modes from

   1. The status bar. You can find a clickable icon with tooltip `Editor Group Arrangement` when you hover on it.

   2. The command palette. Just type `Editor Group Arrangement` and you will find the commands.

3. Enjoy!

## Limitations

- The plugin is still in the early stage, so there might be some bugs.

- In some cases, after switching mode to auto expand, you should *change the active editor* or click on the editor tab to trigger the expand action.

- Since double click on tab of editor will cause Obsidian window to maximize, the plugin does not support double click on tab to expand the editor.

## TODOs

- [x] Write the README

- [x] Fix some bugs that impact the basic functionality

- [x] Support editor expand mode similar to vscode

- [ ] Support ratio mode, for example, 3:1, 1:2:1, 1:1:1:1 etc.

- [ ] Support ratio mode from UI. For example, user can drag the border/input ratio to change the ratio of the editor group.

- [ ] Support custom arrangement mode, by the workspace layout state provided by user. For example, the plugin can read the root split state from workspace layout, and then apply the arrangement to the editor group without replacing the open editors.