moyuguy/sidenote2obsidian

已上架Chrome应用商店

Sidenote2Obsidian 📒

English | 中文

Introduction

Sidenote2Obsidian is a simple Chrome extension that allows you to quickly record ideas on any webpage and send them directly to your Obsidian app. It integrates with the Obsidian community plugin Obsidian Local REST API to seamlessly interact with your notes through a secure local REST API.

Features ✨

• Quickly capture ideas and thoughts while browsing the web
• Automatically save notes to your Obsidian vault
• Customizable note-saving directory
• Intuitive user interface

Installation 🚀

1. Install the Obsidian Local REST API plugin in your Obsidian app.
2. Download the Sidenote2Obsidian extension from the Chrome Web Store.
3. If you can't access the Chrome Web Store, you can also download the extension package from the GitHub releases:
   • Unzip the downloaded package to a preferred location on your computer.
   • Open the Chrome Extensions page (chrome://extensions/), enable Developer mode, and load the unpacked extension by selecting the unzipped folder.

Usage 📋

1. Click the Sidenote2Obsidian extension icon to open the setup dialog.
2. Enter the API Key from the Obsidian Local REST API plugin settings page.
3. Optionally, set the note-saving directory (leave it empty to save in the Obsidian vault root).
4. With the Obsidian app open, click the floating note-taking button to start capturing your ideas.
5. The notes will be saved as Markdown files with a default filename pattern of yyyyMMddhhmm{noteTitle}.md. User-defined filenames are not yet supported.

Contributing 🤝

If you encounter any issues or have suggestions for improvements, please feel free to open an issue on the project's GitHub repository. Pull requests are also welcome!

---

简介

Sidenote2Obsidian 是一个简单的 Chrome 插件,能够让您在浏览网页时快速记录想法,并直接发送到 Obsidian 应用程序。它与 Obsidian 社区插件 Obsidian Local REST API 集成,通过安全的本地 REST API 与您的笔记进行交互。

功能特性 ✨

• 在浏览网页时快速捕捉想法和思路
• 自动将笔记保存到 Obsidian 的笔记库中
• 可自定义笔记保存目录
• 简洁直观的用户界面

安装方式 🚀

1. 在 Obsidian 应用程序中安装 Obsidian Local REST API 插件。
2. 从 Chrome 应用商店下载 Sidenote2Obsidian 扩展程序。
3. 如果无法访问 Chrome 应用商店,您也可以从 GitHub 发布页面下载扩展程序包:
   • 解压缩下载的包文件到您计算机上的首选位置。
   • 打开 Chrome 扩展页面 (chrome://extensions/)、启用开发者模式,然后加载已解压的扩展程序,选择解压缩的文件夹。

使用方法 📋

1. 点击 Sidenote2Obsidian 扩展图标打开设置对话框。
2. 输入 Obsidian Local REST API 插件设置页面上的 API Key。
3. 可选择设置笔记保存目录(留空则保存在 Obsidian 库的根目录)。
4. 在 Obsidian 应用程序打开的情况下,点击悬浮的记笔记按钮开始捕捉您的想法。
5. 笔记将以 Markdown 文件形式保存,默认文件名格式为 yyyyMMddhhmm{noteTitle}.md。暂不支持自定义文件名。

贡献参与 🤝

如果您遇到任何问题或有改进建议,欢迎在项目的 GitHub 仓库中提交 Issue。我们也欢迎您提交 Pull Request 参与贡献。