https://github.com/stevenlafl/return-x-link-preview
Browser extension to return Link Previews to X/Twitter
https://github.com/stevenlafl/return-x-link-preview
browser browser-extension description headline link preview twitter x
Last synced: about 1 month ago
JSON representation
Browser extension to return Link Previews to X/Twitter
- Host: GitHub
- URL: https://github.com/stevenlafl/return-x-link-preview
- Owner: stevenlafl
- Created: 2023-10-05T08:12:06.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-10-08T18:57:45.000Z (over 1 year ago)
- Last Synced: 2025-03-31T06:19:18.169Z (2 months ago)
- Topics: browser, browser-extension, description, headline, link, preview, twitter, x
- Language: TypeScript
- Homepage:
- Size: 240 KB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This is a [Plasmo extension](https://docs.plasmo.com/) project bootstrapped with [`plasmo init`](https://www.npmjs.com/package/plasmo).
## Installation
- Firefox: https://addons.mozilla.org/en-US/firefox/addon/return-x-link-previews/
- Chrome: https://chrome.google.com/webstore/detail/return-x-link-previews/fmheohnbokingmeanjkgpmagmcfpikpa
- Edge, Opera, Brave, Safari (pending review):
- Unzip xxxxx-mv3-prod.zip somewhere.
- Go to the extensions page and click the "Load Unpacked Extension" button and select the unzipped folder for the extension to install it.
## Building/contributing
First, run the development server:
```bash
pnpm dev
# or
npm run dev
```
Open your browser and load the appropriate development build. For example, if you are developing for the chrome browser, using manifest v3, use: `build/chrome-mv3-dev`.
You can start editing the popup by modifying `popup.tsx`. It should auto-update as you make changes. To add an options page, simply add a `options.tsx` file to the root of the project, with a react component default exported. Likewise to add a content page, add a `content.ts` file to the root of the project, importing some module and do some logic, then reload the extension on your browser.
For further guidance, [visit our Documentation](https://docs.plasmo.com/)
## Making production build
Run the following:
```bash
pnpm build
# or
npm run build
```
This should create a production bundle for your extension, ready to be zipped and published to the stores.
## Submit to the webstores
The easiest way to deploy your Plasmo extension is to use the built-in [bpp](https://bpp.browser.market) GitHub action. Prior to using this action however, make sure to build your extension and upload the first version to the store to establish the basic credentials. Then, simply follow [this setup instruction](https://docs.plasmo.com/framework/workflows/submit) and you should be on your way for automated submission!