Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0x6b/copy-selection-as-markdown
Firefox add-on to copy selection as Markdown
https://github.com/0x6b/copy-selection-as-markdown
firefox-addon html-to-markdown markdown
Last synced: 3 months ago
JSON representation
Firefox add-on to copy selection as Markdown
- Host: GitHub
- URL: https://github.com/0x6b/copy-selection-as-markdown
- Owner: 0x6b
- License: mit
- Created: 2017-12-15T19:38:40.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-16T15:33:46.000Z (8 months ago)
- Last Synced: 2024-05-20T19:08:56.515Z (6 months ago)
- Topics: firefox-addon, html-to-markdown, markdown
- Language: HTML
- Homepage: https://addons.mozilla.org/en-US/firefox/addon/copy-selection-as-markdown/
- Size: 8.38 MB
- Stars: 177
- Watchers: 4
- Forks: 14
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-obsidian - Copy Selection as Markdown - on to copy a selection or link as formatted Markdown | [0x6b](https://github.com/0x6b) | (Browser extensions)
README
# Copy Selection as Markdown
Copy title, URL, selection as Markdown
## Install
- Mozilla Firefox: Go to [Add-ons for Firefox](https://addons.mozilla.org/en-US/firefox/addon/copy-selection-as-markdown/) and install.
- Google Chrome: You have to build and install at your own risk. No store distribution at this moment.
## Usage
Right click and select:
- when part of the page is selected: **Copy Selection as Markdown**
- when user context-clicks in the page: **Copy Title and URL as Markdown** (only available on Firefox)
- when user context-clicks in the link: **Copy Link as Markdown** (only available on Firefox)
Toolbar button is also available.
Since v0.18.0, rich text (`text/html`) version of the selection will be copied to the clipboard as well. Almost all of users of this extension might be using plain text editor, but it should be useful for using with [Slack](https://slack.com).
## Settings
The add-on has multiple configuration to suit your setup as follows. Set your preference by:
- Firefox:
1. Click the menu button  and choose  **Add-ons**. The Add-ons Manager tab will open
2. In the Add-ons Manager tab, select the **Extensions** panel
3. Click **Copy Selection as Markdown** and click **Preferences** tab
4. Hit **Save** button on the top to apply changes (no restart required)
- Chrome:
1. Go to `chrome://extension`
2. Click **Copy Selection as Markdown** and click **Details** tab
3. Click **Extension options**
4. Hit **Save** button on the top to apply changes (no restart required)
### General
- Prepend quote (>) to selection
- Include link to source web page in the beginning of copied text
- Enable experimental MathJax support
- Disable link styling (`like this (https://example.com)` instead of `[like this](https://example.com)`)
### Shortcut Key
- macOS: `Command` + `Shift` + `E`
- Windows/Linux: `Ctrl` + `Shift` + `E`
To change shortcut key, click gear icon on top-right and click **Manage Extension Shortcuts**, or `chrome://extensions/shortcuts`.
### Markdown Styles
- Enable GitHub Flavored Markdown (strikethrough, tables, and taskListItems) support
- Use `img` tag for image instead of ``
- Reduce padding spaces for list items
- Replace `<>` with HTML entities
#### Heading style
- Setext
```
Heading 1
=========
Heading 2
---------
```
- ATX (default)
```
# Heading 1
## Heading 2
```
#### Bullet list marker
- Minus (`-`) (default)
```
- one
- two
- three
```
- Plus (`+`)
```
+ one
+ two
+ three
```
- Asterisk (`*`)
```
* one
* two
* three
```
#### Code block style
- Indented (default)
```
let code = "indented";
```
- Fenced
````
```
code = "fenced";
```
````
#### Fence
- Backticks (```) (default)
````
```
let code = "fenced";
```
````
- Tildes (`~`)
```
~~~
let code = "fenced";
~~~
```
#### Em
- Underline (`_`) (default)
```
_Em_
```
- Asterisk (`*`)
```
*Em*
```
#### Strong
- Underlines (`__`)
```
__Strong__
```
- Asterisks (`*`) (default)
```
**Strong**
```
#### Link style
- Inlined (default)
```
[Inlined](https://example.com)
```
- Referenced
```
[Referenced][1]
[1]: https://example.com
```
#### Link reference style
- Reference (default)
```
[Reference][1]
[1]: https://example.com
```
- Collapsed
```
[Reference with collapsed style][]
[Reference with collapsed style]: https://example.com
```
- Shortcut
```
[Reference with shortcut style]
[reference with shortcut style]: https://example.com
```
### Advanced
- Title Substitution -- line separated texts which will be removed from title text. (supports [regular expressions](https://regex101.com/) if the line starts and ends with `/` e.g. `/^number:\d$/`. Please escape `|` with `\`.) If you add ` - Mozilla | MDN` to the textbox, the copied text wil be:
- From `[Add-ons - Mozilla | MDN](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons)`
- To `[Add-ons](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons)`
- Embed `img`s (.gif, .jpg, .jpeg, .png, and .webp) as base64 -- images will be encoded as base64 text, instead of URL, and added at the end of copied text. Sometime it might fail but useful for backup. See [Permissions](#privacy).
## Contributing
Please read [CONTRIBUTING](CONTRIBUTING.md) for details.
## FAQ: Not working on Mozilla related sites
By default, no add-on can interfere pre-configured domains for security reason. You can configure this behavior at either of
- `about:config` → `extensions.webextensions.restrictedDomains` preference. See [Configuration Editor for Firefox | Firefox Help](https://support.mozilla.org/en-US/kb/about-config-editor-firefox) for how to change the preference.
- Starting with Firefox 116, you can also control this behavior for this extension in the Add-ons Manager. See [Why are some add-ons not allowed on sites restricted by Mozilla? | Firefox Help](https://support.mozilla.org/en-US/kb/quarantined-domains?as=u&utm_source=inproduct) for how to change the preference.
Default list of restricted domains (See [modules/libpref/init/all.js](https://searchfox.org/mozilla-central/source/modules/libpref/init/all.js#3147)) as of 2023-08-21:
- accounts-static.cdn.mozilla.net
- accounts.firefox.com
- addons.cdn.mozilla.net
- addons.mozilla.org
- api.accounts.firefox.com
- content.cdn.mozilla.net
- discovery.addons.mozilla.org
- install.mozilla.org
- oauth.accounts.firefox.com
- profile.accounts.firefox.com
- support.mozilla.org
- sync.services.mozilla.com
## License
This extension is released under the MIT License. See [LICENSE](LICENSE) for details.
## Acknowledgements
- [Turndown](https://github.com/domchristie/turndown), which does all the heavy lifting from HTML to markdown
- [Octicons](https://octicons.github.com/) [clippy](https://octicons.github.com/icon/clippy/)
## Privacy
The add-on does not store any user data outside of the Firefox user profile. The conversion to markdown is solely done locally. The add-on never send user action/data to any server.
### Permissions
See [permissions - Mozilla | MDN](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/permissions) for more detail.
| Permission | Optional | Description |
| ---------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `activeTab` | | to run copy functionality at active tab |
| `clipboardWrite` | | to write to clipboard obviously |
| `contextMenus` | | to add context menus |
| `storage` | | to store preferences |
| `` | X | when [**Embed imgs (.gif, .jpg, .jpeg, .png, and .webp) as base64 text as possible** option](#advanced) is set, the extension requests this permission since sometimes referenced images are hosted other than current active tab's URL so `activeTab` permission is not sufficient. If the option's not set, the extension removes this permission. |