Skip to content

anseljh/obsidian-permacc

Repository files navigation

Archive with Perma.cc

This is an Obsidian plugin to create permanent archival links with Perma.cc.

What is Perma.cc and why should I use it?

Perma.cc is an archiving service operated by a consortium of university libraries.

Here is how Perma.cc describes itself:

When a user creates a Perma.cc link, Perma.cc archives the referenced content and generates a link to an archived record of the page. Regardless of what may happen to the original source, the archived record will always be available through the Perma.cc link. To learn more about how Perma.cc works, please take a look at our user guide.

Perma.cc is developed and maintained by the Harvard Law School Library in conjunction with university law libraries across the country and other organizations in the “forever” business.

Configure the plugin

Before you can create permalinks, you must create an account with Perma.cc and find your API key.

Your API key is shown at https://perma.cc/settings/tools. Copy it to your clipboard.

Next, in Obsidian, go to your settings, click Community plugins, and find Archive with Perma.cc. Toggle the plugin on, and then click the gear icon to go to its configuration screen.

A screenshot of the Obsidian settings screen showing the plugin

Paste your API key into the text box.

A screenshot of the plugin's settings screen

Use the plugin

The easist way to archive the source for your current page is to click the new infinity icon in the ribbon.

A screenshot of the Obsidian app's ribbon, showing an infinity icon

You can also use the command in the command palette.

A screenshot of the command palette, showing the command

If you have a url property set in the current note, the plugin will call the Perma.cc API to create an archive, and add the URL to that archive into the permalink property.

A screenshot of the properties of a clipped article on which the plugin has run

Development notes

The plugin uses the Perma.cc API via @harvard-lil/perma-js-sdk, a JavaScript SDK published by the Harvard Library Innovation Lab.

About

Obsidian plugin to create permanent archival links with Perma.cc

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •