Skip to content

LucSPI/MarkDownLoad

Repository files navigation

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: https://vinzent03.github.io/obsidian-advanced-uri/

External Libraries

It uses the following libraries:

  • Readability.js by Mozilla in version from commit 1fde3ac626bc4c2e5e54daa57c57d48b7ed9c574. 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.1 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. It's 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.3.0

  • Remove hidden content before exporting (thanks @nhaouari !). This allows you to use a different extension (e.g. Adblock) to hide elements that would otherwise clutter up your export
  • Fixes for Obsidian integration in Safari (thanks @aancw !)
  • Keep a few more HTML tags that have no markdown equivalent (u, ins, del, small, big) (thanks @mnaoumov !)
  • Add support for KaTeX formulas parsing (thanks @mnaoumov !)
  • Fixed saving for options when imported from file (and show a little 'saved' indicator)
  • Added a toggle for downloading images in the context menu and popup
  • Added a link to the options in the popup
  • Added some basic error handling to the popup
  • Changes to how html inside code blocks is handled (thanks @mnaumov !)
  • Treat codehilite without specified language as plaintext (thanks @mnaoumov !)
  • Ensure sequential line breaks in <pre> are preserved in code blocks (thanks @mnaumov !)
  • Update user guide link in README to point to GitHub
  • Added keyboard shortcuts to copy selection / current tab to obsidian (user-definable in browsers that support that) (thanks @legolasdimir and @likeablob !)
  • Select multiple tabs (hold crtl/cmd) then copy all tab urls as a markdown link list via keyboard shortcut or context menu (thanks @romanPrignon !)
  • Allow users to include custom text such like `{date:YYYY-MM-DD}/`` in their Obsidian Folder Name setting (thanks @likeablob !)
  • Fixed a small typo in the user guide (thanks @devon-research !)
  • Fix for missing headings on sites like Substack (thanks @eactisgrosso !)
  • Add support for websites using MathJax 3 (thanks @LeLocTai !)
  • Moved previous version history into CHANGELOG.md

Previous version history is recorded in CHANGELOG.md

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published