Skip to content

Companion extension for Grimoire - the bookmark manager for the wizards 🧙

License

Notifications You must be signed in to change notification settings

goniszewski/grimoire-web-extension

Repository files navigation

Grimoire Logo

grimoire companion

Web extension for Grimoire - a bookmark manager for the wizards 🧙

GitHub License GitHub Release

Adding bookmarks to Grimoire is now easier than ever! With the Grimoire Companion, you can add bookmarks to your Grimoire account directly from your browser. Just click the extension icon, select the category and tags, and press "Add Bookmark" - it's that simple!

Features

  • add bookmarks to your Grimoire account directly from your browser 🔖
  • create new tags as you add bookmarks 🏷️
  • specify the importance and/or flag the bookmark ⭐
  • automatically fetch metadata from the website using the browser's API 🫶
  • choose if you want to add a screenshot of the website 📸
Grimoire Companion Screenshot

Where to get it?

At the moment, grimoire companion is available for download on the following platforms:

Development

Prerequisites

Steps

# Clone the repository
git clone https://github.com/goniszewski/grimoire-web-extension

# Install the dependencies
pnpm i

# Run the development version
pnpm dev

# Build the production version (by default, this will create the Chrome extension for local development in `build/chrome-mv3-prod`)
pnpm build

How to load the extension in Chrome-based browsers

Development

Check out the the official Plasmo documentation to learn more.

Roadmap

  • Initial release (0.1.0) 🚀

We're open to suggestions and feature requests! If you have an idea for a feature, please open an issue.

Contributing

If you want to contribute to the project, please read the contributing guide.

License

This project is licensed under the MIT License.

Credits

Special thanks to: DaisyUI, Plasmo, Svelte, Svelte French Toast, Svelte MultiSelect, Tailwind CSS