Copy Selection as Markdown

Copy title, URL, selection as Markdown

• Install
• Usage
• Settings
  • General
  • Shortcut Key
  • Markdown Styles
    • Heading style
    • Bullet list marker
    • Code block style
    • Fence
    • Em
    • Strong
    • Link style
    • Link reference style
  • Advanced
• Contributing
• License
• Acknowledgements
• Privacy

Install

Go to Add-ons for Firefox and install.

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
• when user context-clicks in the link: Copy Link as Markdown

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.

Settings

The add-on have multiple configuration to suit your setup as follows. Set your preference by:

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)

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.

Markdown Styles

• Enable GitHub Flavored Markdown (strikethrough, tables, and taskListItems) support
• Use img tag for image instead of ![title](url for image)
• 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]<br/>
  [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. 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)

Contributing

Please read CONTRIBUTING for details.

License

This extension is released under the MIT License. See LICENSE for details.

Acknowledgements

• Turndown, which does all the heavy lifting from HTML to markdown
• Octicons 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.