ObsidianCustomFrames/README.md

32 lines
2.2 KiB
Markdown
Raw Normal View History

2022-03-22 12:03:48 +01:00
# Obsidian Custom Frames
An Obsidian plugin that turns web apps into panes using iframes with custom styling. Also comes with presets for Google Keep and more.
2022-03-20 00:20:09 +01:00
2022-03-26 11:23:11 +01:00
⚠️⚠️⚠️ **For header-heavy sites like Google Keep to work, this plugin requires Obsidian 0.14.3.** ⚠️⚠️⚠️
2022-03-22 17:07:02 +01:00
![A screenshot of the plugin in action](https://raw.githubusercontent.com/Ellpeck/ObsidianCustomFrames/master/screenshot.png)
2022-03-22 13:27:52 +01:00
2022-03-22 17:07:02 +01:00
![A screenshot of the plugin's settings](https://raw.githubusercontent.com/Ellpeck/ObsidianCustomFrames/master/settings.png)
2022-03-22 00:55:20 +01:00
2022-03-22 14:01:49 +01:00
## Usage
To use this plugin, simply go into its settings and add a new frame, either from a preset shipped with the plugin, or a custom one that you can edit yourself. Each frame's pane can be opened using the 'Custom Frames: Open' command.
2022-03-22 14:01:49 +01:00
## Presets
By default, Custom Frames comes with a few presets that allow you to get new panes for popular sites up and running quickly.
- [Obsidian Forum](https://forum.obsidian.md/)
2022-03-26 16:11:30 +01:00
- [Google Keep](https://keep.google.com), optimized for a narrow pane on the side
- [Notion](https://www.notion.so/) (it's recommended to close Notion's sidebar if used as a side pane)
2022-03-22 14:01:49 +01:00
If you create a frame that you think other people would like, don't hesitate to create a pull request with [a new preset](https://github.com/Ellpeck/ObsidianCustomFrames/blob/master/main.ts#L7).
2022-03-22 14:01:49 +01:00
## Roadmap
- ~~Allow setting a custom icon for each pane~~
2022-03-22 14:09:08 +01:00
- Allow displaying custom frames in Markdown code blocks
2022-03-27 15:35:08 +02:00
- Allow creating links that open in a custom frame rather than the browser
2022-03-22 14:06:42 +01:00
- Possibly allow executing custom JavaScript in iframes (though security implications still need to be explored)
## Acknowledgements
Thanks to [lishid](https://github.com/lishid) for their help with making iframes work in Obsidian for a purpose like this. Also thanks to them for *motivating* me to turn Obsidian Keep into a more versatile plugin, which is how Custom Frames was born.
2022-03-22 17:02:39 +01:00
If you like this plugin and want to support its development, you can do so through my website by clicking this fancy image!
[![Support me (if you want), via Patreon, Ko-fi or GitHub Sponsors](https://ellpeck.de/res/generalsupport.png)](https://ellpeck.de/support)