Skip to content

ifitzpat/wallabag.el

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wallabag.el

Wallabag is a self-hostable bookmark manager that provides RSS feeds of your bookmarks. With Wallabag.el you can quickly send urls to wallabag.

Disclaimer: wallabag.el is currently in alpha

Contents

Features

  • Easily add links from elfeed, eww, or whatever is at point to wallabag
  • Easily archive (mark as read) or delete articles, when browsing a wallabag feed in elfeed.

Planned features & improvements:

  • Article tagging (aligned with elfeed)
  • Better sync between elfeed & wallabag

Screenshots

Coming soon

images/wallabag-demo.gif

Installation

Prerequisites

Create a client in your wallabag account and note down the client_id and client_secret.

https://doc.wallabag.org/img/user/browser_api_management.en.png

Dependencies

Quelpa

The package wallabag.el is not currently available from MELPA, but can be installed directly from github with Quelpa.

Installing with Quelpa is easy:

  1. Install quelpa-use-package (which can be installed directly from MELPA).
  2. Add this form to your init file:
(use-package wallabag
  :quelpa (wallabag :fetcher github :repo "ifitzpat/wallabag.el")
  :config
  (setq wallabag-client-id "client-id-of-your-registered-app")
  (setq wallabag-client-secret "client-secret-of-your-registered-app")
  (setq wallabag-url "https://your-wallabag.domain")
  (setq wallabag-username "your-username")
  (setq wallabag-password "your-password")
  )

Usage

Commands

  • Add url (at-point) to wallabag:
    • wallabag-post-link
  • Add current url in eww to wallabag:
    • wallabag-eww-add-url
  • Add elfeed entry at point to wallabag from elfeed-search:
    • elfeed-search-wallabag-add
  • Add elfeed entry to wallabag from elfeed-show (when viewing an article):
    • elfeed-show-wallabag-add
  • Delete elfeed entry from wallabag from elfeed-show (when viewing an article in a wallabag RSS feed):
    • elfeed-show-wallabag-delete
  • Archive elfeed entry in wallabag from elfeed-show (when viewing an article in a wallabag RSS feed):
    • elfeed-show-wallabag-archive

Changelog

Note: Breaking changes may be made before version 1.0, but in the event of major changes, attempts at backward compatibility will be made with obsolescence declarations, translation of arguments, etc. Users who need stability guarantees before 1.0 may choose to use tagged stable releases.

0.0.2-alpha

  • Inherit elfeed tags when sending a link to wallabag from elfeed
  • Add/Remove tags in wallabag when you do so in elfeed

0.0.1-alpha

Initial release

Notes

Known issues

Credits

  • Credit to prot for the function to get eww’s current url.
  • Credit to skeeto for the excellent elfeed RSS reader.

License

GPLv3

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published