TiddlyWiki Collector: A Browser Extension connect to NodeJS Version of TiddlyWiki or TidGi APP

中文 Readme

Features

• Clip webpage, save as markdown or wikitext to your wiki.
• Bookmark a webpage URI as a tiddler in your wiki.
  • And show it in a browser sidebar (WIP).
  • Search & View bookmarked tiddlers in browser (WIP).
• Search your wiki from address bar (WIP).

Usage

1. Add your Nodejs TiddlyWiki's WebServer API URL to the "Options" of this extension.
2. Click on extension icon to open popup of this extension. You can see some buttons to save the page to your wiki.

Browser Support

Install	Install	Install	Install	Install

Screenshots

The popup when you Click on extension icon:

With English localization:

Development

Ensure you have

• Node.js 16 or later installed
• pnpm installed

Then run the following:

• pnpm install to install dependencies.
• pnpm dev to start the development server.
• pnpm build to build an unpacked extension in dist dist-firefox, and bundle packed zips in bundle folder.

Load dev extension in Chrome (Chromium, Manifest V3)**

1. Go to the browser address bar and type chrome://extensions
2. Check the Developer Mode button to enable it.
3. Click on the Load Unpacked Extension button.
4. Select your dist folder in the project root.

Load dev extension in Firefox (Partial Manifest V3)**

1. Go to the browser address bar and type about:debugging#/runtime/this-firefox (not the about:addons)
2. Click on the Load Temporary Add-on list item after click on setting button.
3. Select your dist-firefox folder in the project root.
4. Debug popup in firefox

Other Commands

• pnpm clean to remove dist folder. dev and build commands call this command.
• pnpm format to fix code with eslint and prettier.
• pnpm lint to call ESLint and Prettier.
• pnpm test for testing.

Upload to Store

1. tag a git commit with vx.x.x or vx.x.x-xxx
2. Github Action will auto release new zips to https://github.com/tiddly-gittly/Browser-Extension-Tiddlywiki-Collector/releases
3. Manually upload zip to stores

• Firefox: https://addons.mozilla.org/zh-CN/developers/addons
• Chrome: https://chrome.google.com/u/2/webstore/devconsole

zustand

You can use zustand (zustand-toolkit) as state manager between popup, background, content and custom pages. Read the documentation for more.

@eduardoac-skimlinks/webext-zustand

Bundling

@crxjs/vite-plugin

Note This plugin powers the development side of this starter.

docs: https://crxjs.dev/vite-plugin

Special thanks to @jacksteamdev and contributors for this amazing plugin.

Contributing

This repository is following the Conventional Commits standard.

Privacy

This Extension is local-first, don't collect any user data.