Skip to content

Commit

Permalink
Merge branch 'release/3.1.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
deathau committed Nov 9, 2020
2 parents da3a11c + 6072aee commit 7b830e2
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 15 deletions.
44 changes: 31 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Sliding Panes (Andy Matuschak Mode) Obsidian Plugin
![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)
[![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)
![GitHub All Releases](https://img.shields.io/github/downloads/deathau/sliding-panes-obsidian/total?style=for-the-badge)

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

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

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

### Settings
There is a setting to enable or disable the sliding panes effect, which is also
registered as a command, so you can toggle it from the command pallette or
assign a hotkey in the settings.

There are also two settings for heading width (the width of the rotated header)
and the leaf width (the width of a single markdown page).
- **Toggle Sliding Panes** - Turns sliding panes on or off globally *(also available via command/hotkey)*
- **Leaf Width** - The default width of a single pane
- **Toggle rotated headers** - Rotates headers to use as spines *(also available via command/hotkey)*
- **Swap rotated header direction** - Swaps the direction of rotated headers *(also available via command/hotkey)*
- **Toggle stacking** - Panes will stack up to the left and right *(also available via command/hotkey)*
- **Spine Width** - The width of the rotated header (or gap) for stacking

### Compatibility

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

## Security
> Third-party plugins can access files on your computer, connect to the internet, and even install additional programs.
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.

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.

## Development

This project uses Typescript to provide type checking and documentation.
Expand All @@ -81,14 +89,24 @@ 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
## 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](https://paypal.me/deathau) or sponsor me via
[GitHub Sponsors](https://github.com/sponsors/deathau)
much, feel free to throw some coins in my hat via the following:

[![GitHub Sponsors](https://img.shields.io/github/sponsors/deathau?style=social)](https://github.com/sponsors/deathau)
[![Paypal](https://img.shields.io/badge/paypal-deathau-yellow?style=social&logo=paypal)](https://paypal.me/deathau)

# Version History
## 3.1.0
- Update the link suggestion container position (thanks again, @erichalldev)
- Add the option (and command palette command) to turn stacking off (i.e. slide-off mode, like the v1 of Andy's Mode CSS)
- Add the option (and command palette command) to make the rotated header titles face the other direction
- Add a command palette command to toggle rotated headers
- Allow pane resizing (except the last pane, because it doesn't have a handle currently)
- Fix an issue with switching to off-screen panes not animating correctly (can still jump without animation if you switch too far too quickly)

## 3.0.2
- Add a setting to disable rotated headers
- Update focusLeaf to scroll just far enough to make a leaf fully visible if it's out of view to the right (thanks @erichalldev)
Expand Down
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
"isDesktopOnly": false,
"js": "main.js",
"css": "styles.css",
"version": "3.0.2"
"version": "3.1.0"
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "sliding-panes-obsidian",
"version": "3.0.2",
"version": "3.1.0",
"description": "Sliding Panes (Andy Matuschak Mode) plugin for Obsidian (https://obsidian.md)",
"main": "main.js",
"scripts": {
Expand Down

0 comments on commit 7b830e2

Please sign in to comment.