Skip to content

Commit 7b830e2

Browse files
committed
Merge branch 'release/3.1.0'
2 parents da3a11c + 6072aee commit 7b830e2

File tree

3 files changed

+33
-15
lines changed

3 files changed

+33
-15
lines changed

README.md

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Sliding Panes (Andy Matuschak Mode) Obsidian Plugin
2-
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/deathau/sliding-panes-obsidian/Build%20obsidian%20plugin?logo=github&style=for-the-badge) [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/deathau/sliding-panes-obsidian?style=for-the-badge&sort=semver)](https://github.com/deathau/sliding-panes-obsidian/releases/latest)
1+
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/deathau/sliding-panes-obsidian?style=for-the-badge&sort=semver)](https://github.com/deathau/sliding-panes-obsidian/releases/latest)
2+
![GitHub All Releases](https://img.shields.io/github/downloads/deathau/sliding-panes-obsidian/total?style=for-the-badge)
33

44
Sliding Panes (Andy Matuschak Mode) as a plugin for [Obsidian](https://obsidian.md).
55

@@ -8,8 +8,8 @@ Sliding Panes (Andy Matuschak Mode) as a plugin for [Obsidian](https://obsidian.
88
This plugin changes the way panes in the main workspace are handled — inspired by
99
the UI of [Andy Matuschak's notes](https://notes.andymatuschak.org/).
1010
Instead of shrinking the workspace to fit panels, the panels will remain a fixed
11-
width and stack so you can scroll between them. Note headers are rotated and added
12-
to the left of the pane like a spine, and will stack up as you scroll, allowing
11+
width (but resizable) and stack so you can scroll between them. Note headers are rotated and added
12+
to the left of the pane like a spine (optional), and will stack up as you scroll (also optional), allowing
1313
easy navigation between them.
1414

1515
(Note: To open links in a new pane in Obsidian, ctrl/cmd click them)
@@ -18,14 +18,15 @@ easy navigation between them.
1818
- Note headers stack up on the right _as well as_ the left.
1919
- Changing an active pane scrolls that pane into view.
2020
- Togglable without having to copy CSS into your theme.
21+
- Togglable features, such as the rotated headers and stacking
2122

2223
### Settings
23-
There is a setting to enable or disable the sliding panes effect, which is also
24-
registered as a command, so you can toggle it from the command pallette or
25-
assign a hotkey in the settings.
26-
27-
There are also two settings for heading width (the width of the rotated header)
28-
and the leaf width (the width of a single markdown page).
24+
- **Toggle Sliding Panes** - Turns sliding panes on or off globally *(also available via command/hotkey)*
25+
- **Leaf Width** - The default width of a single pane
26+
- **Toggle rotated headers** - Rotates headers to use as spines *(also available via command/hotkey)*
27+
- **Swap rotated header direction** - Swaps the direction of rotated headers *(also available via command/hotkey)*
28+
- **Toggle stacking** - Panes will stack up to the left and right *(also available via command/hotkey)*
29+
- **Spine Width** - The width of the rotated header (or gap) for stacking
2930

3031
### Compatibility
3132

@@ -61,6 +62,13 @@ Note: On some machines the `.obsidian` folder may be hidden. On MacOS you should
6162
Otherwise head to Settings, third-party plugins, make sure safe mode is off and
6263
enable Sliding Panes from there.
6364

65+
## Security
66+
> Third-party plugins can access files on your computer, connect to the internet, and even install additional programs.
67+
68+
The source code of this plugin is available on GitHub for you to audit yourself, but installing plugins into Obsidian is currently a matter of trust.
69+
70+
I can assure you here that I do nothing to collect your data, send information to the internet or otherwise do anything nefarious with your system. However, be aware that I *could*, and you only have my word that I don't.
71+
6472
## Development
6573

6674
This project uses Typescript to provide type checking and documentation.
@@ -81,14 +89,24 @@ Alternately, you can clone the repo directly into your plugins folder and once
8189
dependencies are installed use `npm run dev` to start compilation in watch mode.
8290
You may have to reload obsidian (`ctrl+R`) to see changes.
8391

92+
## Pricing
8493
## Pricing
8594
Huh? This is an open-source plugin I made *for fun*. It's completely free.
8695
However, if you absolutely *have* to send me money because you like it that
87-
much, feel free to throw some coins in my hat via
88-
[PayPal](https://paypal.me/deathau) or sponsor me via
89-
[GitHub Sponsors](https://github.com/sponsors/deathau)
96+
much, feel free to throw some coins in my hat via the following:
97+
98+
[![GitHub Sponsors](https://img.shields.io/github/sponsors/deathau?style=social)](https://github.com/sponsors/deathau)
99+
[![Paypal](https://img.shields.io/badge/paypal-deathau-yellow?style=social&logo=paypal)](https://paypal.me/deathau)
90100

91101
# Version History
102+
## 3.1.0
103+
- Update the link suggestion container position (thanks again, @erichalldev)
104+
- Add the option (and command palette command) to turn stacking off (i.e. slide-off mode, like the v1 of Andy's Mode CSS)
105+
- Add the option (and command palette command) to make the rotated header titles face the other direction
106+
- Add a command palette command to toggle rotated headers
107+
- Allow pane resizing (except the last pane, because it doesn't have a handle currently)
108+
- Fix an issue with switching to off-screen panes not animating correctly (can still jump without animation if you switch too far too quickly)
109+
92110
## 3.0.2
93111
- Add a setting to disable rotated headers
94112
- Update focusLeaf to scroll just far enough to make a leaf fully visible if it's out of view to the right (thanks @erichalldev)

manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55
"isDesktopOnly": false,
66
"js": "main.js",
77
"css": "styles.css",
8-
"version": "3.0.2"
8+
"version": "3.1.0"
99
}

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "sliding-panes-obsidian",
3-
"version": "3.0.2",
3+
"version": "3.1.0",
44
"description": "Sliding Panes (Andy Matuschak Mode) plugin for Obsidian (https://obsidian.md)",
55
"main": "main.js",
66
"scripts": {

0 commit comments

Comments
 (0)