Skip to content

This plugin scans the opened note for links and submits them all to the Internet Archive's Wayback Machine (https://web.archive.org/).

License

Notifications You must be signed in to change notification settings

baocin/obsidian-link-archiver

Repository files navigation

Obsidian Link Archiver Plugin

A quick, minimal (but working!) Obsidian(https://obsidian.md) plugin to submit all links found in a given note to the Internet Archive's Wayback Machine (https://web.archive.org/) for archiving.

!!! Remember they are a non-profit so please don't spam them with a thousand links.

Future Plans

  • Add a setting to auto-replace links with the web-archive url.
  • Make progress modal in the status bar instead of a bit scary modal.

Quick setup guide:

  • Clone the repo to a local development folder. For convenience, you can place this folder in your .obsidian/plugins/your-plugin-name folder.
  • Install NodeJS, then run npm i in the command line under your repo folder.
  • Run npm run dev to compile the plugin from main.ts to main.js.
  • Make changes to main.ts (or create new .ts files). Those changes should be automatically compiled into main.js.
  • Reload Obsidian (CTRL + SHIFT + i) to load the new version of your plugin.
  • Enable plugin in settings window.
  • For updates to the Obsidian API run npm update in the command line under your repo folder.

Releasing new releases

  • Update your manifest.json with your new version number, such as 1.0.1, and the minimum Obsidian version required for your latest release.
  • Update your versions.json file with "new-plugin-version": "minimum-obsidian-version" so older versions of Obsidian can download an older version of your plugin that's compatible.
  • Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix v. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
  • Upload the files manifest.json, main.js, styles.css as binary attachments.
  • Publish the release.

Manually installing the plugin

  • Copy over main.js, styles.css, manifest.json to your vault VaultFolder/.obsidian/plugins/your-plugin-id/.

API Documentation

See https://github.com/obsidianmd/obsidian-api

About

This plugin scans the opened note for links and submits them all to the Internet Archive's Wayback Machine (https://web.archive.org/).

Resources

License

Stars

Watchers

Forks

Packages

No packages published