Git Product home page Git Product logo

markdownload's Introduction

MarkDownload - Markdown Web Clipper

GitHub release (latest SemVer) Mozilla Add-on Chrome Web Store

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

Context Menus

You can also right-click on pages, images, links and selections to copy or download snippets of Markdown.
You can also download all tabs in a window as Markdown files

External Libraries

It uses the following libraries:

  • Readability.js by Mozilla in version from commit 52ab9b5c8916c306a47b2119270dcdabebf9d203. 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.0.1 is used to convert the simplified HTML (from Readability.js) into markdown. (Licensed under MIT License)
  • Moment.js version 2.27.0 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

Installation

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


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

Pricing

Huh? This is an open-source extension I made for fun. It's completely free. However, if 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

2.4.1

  • Add option for Obsidian-style image links (when downloading images with the markdown file)
  • Downloaded images should download relative to the markdown file in the case where you specify a subfolder in your title template
  • Front- and back-matter template will no longer put in extra lines on Opera
  • Adjusted the way text is copied to the clipboard

2.4.0

  • Fixed typo on options page (thanks Dean Cook)
  • Added option to download images alongside the markdown file
    • Also added the ability to add a prefix to the images you download, so you can, for example, save them in a subfolder
    • If your browser has the option to always show a save as dialog enabled, you might get a dialog for every image. Sorry about that ๐Ÿ˜ฌ
  • Updated turndown to 7.0.1 and allowed iframes to be kept in the markdown
  • Added a new {pageTitle} option for template replacement (there are many websites where the {title} and {pageTitle} actually differ)
  • Added a context menu option to copy a tab URL as a markdown link, using the title configured in settings as the link title (i.e. [<custom title>](<URL>))
  • Added custom disallowed characters to strip from titles (set to []#^ by default for maximum compatibility with Obsidian)
  • Added some focus styling so you can tell what is focused
  • Auto-focus the download button (you can now ctrl+shift+M, Enter to quickly download a file)
  • Template title (and image prefixes) now allow forward slashes (/) so that files get saved to a subfolder

2.3.1

  • Added template toggle to Firefox's tab context menu

2.3.0

  • Added contexy menus for copying markdown
  • Added options to clip selected text
  • Include front-matter/back-matter templates in popup
  • Add title templating
  • Added keyboard shortcut to show the popup
  • Added option to always show Save As
  • Added context menus to download all tabs as markdown

2.2.0

  • Added extension options
    • Turndown (markdown generation) options
    • Front-matter/back-matter templates with replacement variables from page metadata (and date)

2.1.6

  • Replace non-breaking spaces in filenames

2.1.5

  • Fixed an issue with sites with invalid <base> tags

2.1.4

  • Fixed issue with relative links #1

2.1.3

markdownload's People

Contributors

gordonped avatar deathau avatar enrico-kaack avatar deanrobertcook avatar

Stargazers

Moazzam Mohammed Sayyed avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.