Skip to content

Latest commit

 

History

History
89 lines (66 loc) · 7.2 KB

README.md

File metadata and controls

89 lines (66 loc) · 7.2 KB
Raw

MarkDownload - Markdown Web Clipper

GitHub release (latest SemVer)

This is an extension to clip websites and download them into a readable markdown file. Please keep in mind that it is not guaranteed to work on all websites.

To use this add-on, simply click the add-on icon while you are browsing the page you want to save offline. A popup will show the rendered markdown so you can make minor edits or copy the text, or you can click the download button to download an .md file.
Selecting text will allow you to download just the selected text

See the Markdownload User Guide for more details on the functionality of this extension

Installation

The extension is available for Firefox, Google Chrome, Microsoft Edge and Safari.

iTunes App Store

Obsidian Integration

For integration with obsidian, you need to install and enable community plugins named "Advanced Obsidian URI". This plugin help us to bypass character limitation in URL. Because it's using clipboard as the source for creating new file. More information about Advanced Obsidian URI plugin: https://vinzent03.github.io/obsidian-advanced-uri/

You need to do some configurations in order to use this integration.

Steps to follow
  1. Left-Click on the extension
  2. Click on the gear icon to open the configuration menu
  3. Scroll down to "Obsidian integration" section and turn "enable obsidian integration" on.
  4. Fill out the form below (Obsidian vault name and Obsidian folder name.)
  5. Right-click on the extension and open the menu
  6. In "MarkDownload - Markdown Web Clipper", select "Send Tab to Obsidian"

External Libraries

It uses the following libraries:

  • Readability.js by Mozilla version 0.5.0. This library is also used for the Firefox Reader View and it simplifies the page so that only the important parts are clipped. (Licensed under Apache License Version 2.0)
  • Turndown by Dom Christie in version 7.1.3 is used to convert the simplified HTML (from Readability.js) into markdown. (Licensed under MIT License)
  • Moment.js version 2.29.4 used to format dates in template variables

Permissions

  • Data on all sites: used to enable "Download All Tabs" functionality - no other data is captured or sent online
  • Access tabs: used to access the website content when the icon in the browser bar is clicked.
  • Manage Downloads: necessary to be able to download the markdown file.
  • Storage: used to save extension options
  • Clipboard: used to copy Markdown to clipboard

The Common Mark icon courtesy of https://github.com/dcurtis/markdown-mark

Pricing

This is an open-source extension I made for fun. Its intention is to be completely free. It's free on Firefox, Edge and Chrome (and other Chromium browsers), but unfortunately for Safari there is a yearly developer fee, so I've decided to charge a small price for the Safari version to help cover that cost. Alternately, you can become a GitHub Sponsor for as little as $2 per month and you can request a key for the Safari version. Also, even if you're using the free version and you absolutely have to send me money because you like it that much, feel free to throw some coins in my hat via the following:

GitHub Sponsors Paypal

Version History

3.4.0

  • Fixed extra spaces in titles which could cause issues (thanks @rickdoesdev !)
  • Fixed an issue with image paths in some circumstances (thanks @rickdoesdev !)
  • Added parametersizations for "mixed-kebab" and "mixed_snake" which retain original casing but replace spaces (thanks @NSHenry !)
    • Also added a special "obsidian-cal" parameterization which is the same as "mixed-kebab" with duplicate - removed for additional compatibility with the Obsidian Consistent Attachment Location plugin (thanks @NSHenry !)
  • Added lowecase and uppercase options to parameterizations (thanks @redxtech !)
  • Updated Turndown to v7.1.3 (thanks @WeHat !)
  • Updated Readability to v0.5.0 (thanks @WeHat !)
  • Fixed some issues with code block parsing and formatting (thanks @WeHat !)
  • Fixed an issue with some sites missing a proper title (thanks @WeHat !)
  • Fixed an issue with bad base urls causing issues with links in certain circumstances (thanks @WeHat !)
  • Fixed an issue with readability removing everything in certain circumstances (thanks @WeHat !)
  • Send properly configured title to the Obsidian integration (thanks @nekton39 !)
  • Updates to the README (thanks @2gn and @eugenesvk !)

Previous version history is recorded in CHANGELOG.md