ariesdevil · May 12, 2020 · May 12, 2020 · May 13, 2020 · May 13, 2020 · May 13, 2020
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,2 @@
+github: deathau
+custom: ["https://www.paypal.me/deathau"]
diff --git a/.github/workflows/addIssuesToProject.yml b/.github/workflows/addIssuesToProject.yml
@@ -0,0 +1,18 @@
+name: Add issues to MarkDownload project
+
+on:
+  issues:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    name: Add issue to project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v0.4.0
+        with:
+          # You can target a repository in a different organization
+          # to the issue
+          project-url: https://github.com/users/deathau/projects/1
+          github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
diff --git a/.gitignore b/.gitignore
@@ -1 +1,5 @@
-web-ext-artifacts/markdown-clipper-1.0.zip
+web-ext-artifacts
+xcode/MarkDownload - Markdown Web Clipper/MarkDownload - Markdown Web Clipper.xcodeproj/project.xcworkspace
+xcode/MarkDownload - Markdown Web Clipper/MarkDownload - Markdown Web Clipper.xcodeproj/xcuserdata
+.DS_Store
+node_modules
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,136 @@
+# Changelog
+## 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 !)
+## 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 !)
+## 3.2.1
+- Bugfixes for the Obsidian integration (thanks @aancw !)
+## 3.2.0
+- Added a basic Obsidian integration using the [Obsidian Advanced URI](https://vinzent03.github.io/obsidian-advanced-uri/) plugin and clipboard (thanks @aancw !)
+- Keep sub/sup tags so that superscript and subscript text is retained (thanks @mnaoumov !)
+- Added a keyboard shortcut for copy selection as markdown (nothing by default, needs to be user-configured)
+- Added a new context menu item to copy all tabs as a list of markdown links
+- Updated dependencies
+
+## 3.1.0
+- Firefox for Android (nightly) support
+- Updated Readability and Turndown
+- Added GitHub-flavoured Markdown (GFM) plugin to Turndown (adds some mardown table support)
+- Added support for MathJax -> LaTeX (thanks @LeLocTai)
+- Disallow slashes in title text replacements
+- Suport for Open Graph meta tags as variables (which use `property` instead of `key`)
+- Fixed an issue with regex characters like `|` in date formats
+- Resolved an extra slash in file name causing images to fail to download in chromium browsers
+- Added some support to parse pre elements as code blocks (supports syntax highlighting on GitHub, but not much else yet)
+- Added option to enable or disable the context menus
+- Added some extra keyboard shortcuts. These can be customised, depending on your browser
+    - <kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>M</kbd> opens the popup (as it has in previous versions)
+    - <kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>D</kbd> downloads the current tab as markdown, bypassing the popup
+    - <kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> copies the current tab as markdown to the clipboard, bypassing the popup
+    - <kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> copies the current tabs URL as a markdown link to the clipboard
+- Added support for template variables having different casing using `:` followed by the casing type. For example, for an article titled "Different Types of Casing":
+    - `{pageTitle:pascal}` — "DifferentTypesOfCasing"
+    - `{pageTitle:camel}` — "differentTypesOfCasing"
+    - `{pageTitle:kebab}` — "different-types-of-casing"
+    - `{pageTitle:snake` — "different_types_of_casing"
+- Added support for rending italics in double underscores (`__`). This isn't valid MarkDown (will output as __bold__), but it's useful for people copying to Roam
+- Support image download as base64 embedded urls, directly in the markdown file
+- Added some extra variables related to the url beyond the existing `{baseURI}`:
+    - `{origin}` - The origin of the URL, that is its scheme, its domain and its port
+    - `{host}` - The domain (that is the _hostname_) followed by (if a port was specified) a `:` and the _port_ of the URL.
+    - `{hostname}` - The domain of the URL.
+    - `{port}` - The port number of the URL.
+    - `{protocol}` - The protocol scheme of the URL, including the final `':'`.
+    - `{pathname}` - An initial `'/'` followed by the path of the URL, not including the query string or fragment.
+    - `{search}` - The URL's parameter string; if any parameters are provided, this string includes all of them, beginning with the leading `?` character.
+
+## 3.0.0
+- Theme revamp
+- Utilizing CodeMirror for the Markdown Editor
+- Strip Disallowed characters on title and image filenames during text replacement
+- Add "Download Type" option, to attempt to resolve conflicts with other Download extensions (and to help support Safari!)
+- Add options for stripping images and links
+- Fixes around downloading images and getting correct urls in the markdown
+- Added meta keywords support for the text replace
+- Added text replace support for meta tags in general
+- Add option to disable turndown escaping
+- Strip out 'red dot' special characters
+- Added an option to specify a download path (within the downloads folder). Thanks to Nikita Lukianets!
+
+## 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](https://github.com/deathau/markdownload/issues/1)
+
+## 2.1.3
+- Fist change, forked from [enrico-kaack/markdown-clipper](https://github.com/enrico-kaack/markdown-clipper)
+- Added URL to markdown output ([#5](https://github.com/deathau/markdownload/issues/5))
diff --git a/PRIVACY.md b/PRIVACY.md
@@ -0,0 +1,23 @@
+# Privacy Policy
+
+This page is used to inform visitors regarding our policies with the collection, use, and disclosure of Personal Information if anyone
+using the MarkDownload browser extension (the Service).
+
+tl;dr: We don't collect anything. Any information we clip from websites remains on your machine.
+
+## Information Collection and Use
+This extension reads data on a website you are visiting when you click the button. The URL, metadata and content are clipped and fed
+through third-party javascript libraries to transofrm it into the Markdown you see in the preview.
+
+None of this data is collected or sent back to any server. Any files you download or text you copy from the extension remains on your
+machine and none of it is collected by me.
+
+The settings of the extension get stored in the browser's local storage and likewise are never collected or transmitted by me.
+
+## Changes to This Privacy Policy
+I may update this Privacy Policy from time to time, for example if new features are developed which require data collection.
+Thus, it might be a good idea to review this page periodically for any changes. Any changes are effective immediately, as they are
+posted on this page. Editing this page constitutes a notification that the Privacy Policy has changed
+
+## Contact Me
+If you have any questions or suggestions about this Privacy Policy, do not hesitate to contact me.
diff --git a/README.md b/README.md
@@ -1,17 +1,89 @@
-# markdown-clipper
+# MarkDownload - Markdown Web Clipper
 
-This is a Firefox and Google Chrome extension to clip websites and download them into a readable markdown file.
+[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/deathau/markdownload?style=for-the-badge&sort=semver)](https://github.com/deathau/markdownload/releases/latest)
 
-It uses the following two libraries:
-- [Readability.js](https://github.com/mozilla/readability) by Mozilla in version from commit [977be42d1fb33781401001318813ab9fe4568647](https://github.com/mozilla/readability/commit/977be42d1fb33781401001318813ab9fe4568647#diff-06d8d22df421dacde90a2268083424ab). 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](https://github.com/domchristie/turndown) by Dom Christie in version 5.0.1 is used to convert the simplified HTML (from Readability.js) into markdown. (Licensed under MIT License)
+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](https://github.com/deathau/markdownload/blob/master/user-guide.md#markdownload-user-guide) for more details on the functionality of this extension
 
 # Installation
-The plugin is available for [Firefox](https://addons.mozilla.org/de/firefox/addon/markdown-clipper/) and [Google Chrome](https://chrome.google.com/webstore/detail/markdown-clipper/cjedbglnccaioiolemnfhjncicchinao).
+The extension is available for [Firefox](https://addons.mozilla.org/en-GB/firefox/addon/markdownload/), [Google Chrome](https://chrome.google.com/webstore/detail/markdownload-markdown-web/pcmpcfapbekmbjjkdalcgopdkipoggdi), [Microsoft Edge](https://microsoftedge.microsoft.com/addons/detail/hajanaajapkhaabfcofdjgjnlgkdkknm) and [Safari](https://apple.co/3tcU0pD).
+
+[![](https://img.shields.io/chrome-web-store/v/pcmpcfapbekmbjjkdalcgopdkipoggdi.svg?logo=google-chrome&style=flat)](https://chrome.google.com/webstore/detail/markdownload-markdown-web/pcmpcfapbekmbjjkdalcgopdkipoggdi) [![](https://img.shields.io/chrome-web-store/rating/pcmpcfapbekmbjjkdalcgopdkipoggdi.svg?logo=google-chrome&style=flat)](https://chrome.google.com/webstore/detail/markdownload-markdown-web/pcmpcfapbekmbjjkdalcgopdkipoggdi) [![](https://img.shields.io/chrome-web-store/users/pcmpcfapbekmbjjkdalcgopdkipoggdi.svg?logo=google-chrome&style=flat)](https://chrome.google.com/webstore/detail/markdownload-markdown-web/pcmpcfapbekmbjjkdalcgopdkipoggdi)
+
+[![](https://img.shields.io/amo/v/markdownload.svg?logo=firefox&style=flat)](https://addons.mozilla.org/en-US/firefox/addon/markdownload/) [![](https://img.shields.io/amo/rating/markdownload.svg?logo=firefox&style=flat)](https://addons.mozilla.org/en-US/firefox/addon/markdownload/) [![](https://img.shields.io/amo/users/markdownload.svg?logo=firefox&style=flat)](https://addons.mozilla.org/en-US/firefox/addon/markdownload/)
+
+[![](https://img.shields.io/badge/dynamic/json?label=edge%20add-on&prefix=v&query=%24.version&url=https%3A%2F%2Fmicrosoftedge.microsoft.com%2Faddons%2Fgetproductdetailsbycrxid%2Fhajanaajapkhaabfcofdjgjnlgkdkknm&style=flat&logo=microsoft-edge)](https://microsoftedge.microsoft.com/addons/detail/hajanaajapkhaabfcofdjgjnlgkdkknm) [![](https://img.shields.io/badge/dynamic/json?label=rating&suffix=/5&query=%24.averageRating&url=https%3A%2F%2Fmicrosoftedge.microsoft.com%2Faddons%2Fgetproductdetailsbycrxid%2Fhajanaajapkhaabfcofdjgjnlgkdkknm&style=flat&logo=microsoft-edge)](https://microsoftedge.microsoft.com/addons/detail/hajanaajapkhaabfcofdjgjnlgkdkknm)
+
+[![iTunes App Store](https://img.shields.io/itunes/v/1554029832?label=Safari&logo=safari&style=flat)](https://apple.co/3tcU0pD)
+
+# 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.
+<details>
+  <summary>Steps to follow</summary>
+
+  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"
+
+</details>
+
+
+
+# External Libraries
+It uses the following libraries:
+- [Readability.js](https://github.com/mozilla/readability) by Mozilla version [0.5.0](https://github.com/mozilla/readability/releases/tag/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](https://github.com/mixmark-io/turndown) by Dom Christie in version [7.1.3](https://github.com/mixmark-io/turndown/releases/tag/v7.1.3) is used to convert the simplified HTML (from Readability.js) into markdown. (Licensed under MIT License)
+- [Moment.js](https://momentjs.com) 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: neccessary to be able to download the markdown file.
+- 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 icon was created using [Favicon.io ](https://favicon.io)
+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](https://img.shields.io/github/sponsors/deathau?style=social)](https://github.com/sponsors/deathau)
+[![Paypal](https://img.shields.io/badge/paypal-deathau-yellow?style=social&logo=paypal)](https://paypal.me/deathau)
+
+# 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](./CHANGELOG.md)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		github: deathau
		custom: ["https://www.paypal.me/deathau"]