Back to Markdown Here

Markdown Here Options

src/common/options.html

2.16.05.7 KB
Original Source

Basic Usage

  1. Click the "Extensions" button on your toolbar, then pin the Markdown Here button.
  2. Start a new email message.
  3. Type some Markdown into the email.
    Try this: _Hello_ Markdown **Here**!
  4. Right-click in the email and then click "Markdown Toggle". (Or click the button on the toolbar. Or press Alt+Shift+M)
  5. The message should now look pretty cool. Send it to your friends!

Options Page

  • Changes are automatically saved and synchronized (if sync is enabled in your browser).
  • The syntax highlighting styles are applied after the primary styling, and so take precedence.
  • Some email editors and browsers impose their own styles. Those may not be apparent here.

Resources and Links


Once you decide Markdown Here is pretty sweet, please help me to buy some flowers for my wife so she's not too upset about how much time I spend working on it. Thank you!** Help make Markdown Here better! **Help support the development of Markdown Here! You know what makes it easier to keep Markdown Here working on Chrome, Firefox, Thunderbird, Opera, Gmail, Yahoo, Hotmail, Blogger, Evernote, etc.? Coffee! Other donation options

Primary Styling CSS

Reset to Default

Syntax Highlighting CSS

Theme:

Preview

Markdown Toggle

TeX Mathematical Formulae Support

Reset to Default

Privacy Issues:

  • To generate the image for the formula, a request is sent to CodeCogs. That effectively means that you are sharing your formula with CodeCogs. It also means that recipients of your message will be making a request to CodeCogs to have the image rendered.
  • If you customize the formula rendering tag, you should use a secure (https://) path. Not all rendering services provide a secure option.

Customization and Use:

  • If this feature is enabled, text between dollar signs — $ — will be interpreted as mathematical formulae. For example, $\Delta$ would be rendered as a delta symbol.

  • For render customization options, see the CodeCogs documentation for this service.

  • A good resource for creating TeX formulae is the CodeCogs Equation Editor.

  • Formulae are rendered to images, so email recipients will have to enable images to be shown to see the rendering.

  • If you customize the rendering tag, you can (and should) use either or both of {mathcode} and {urlmathcode} as placeholders.

    • {mathcode}: The text between the $ symbols — i.e., the raw TeX formula; like \Delta.
    • {urlmathcode}: The URL-encoded form of the TeX formula; like %5CDelta.
  • If you customize the `` tag, you should include an alt attribute that has as human-readable a value as possible, like {mathcode}. This value of this attribute will be used for the plaintext version of the email (when sent from Gmail and Thunderbird), and used by screen readers for sight-impaired recipients.

Advanced and Miscellaneous

Enable "forgot-to-render" check.

Currently only supported in Gmail and Thunderbird. If enabled, expect a prompt asking you to give MDH permission to access mail.google.com.

When you send an email, this checks the content to see if it looks like you wrote it in Markdown, but forgot to render it (i.e., click "Markdown Toggle") before sending. This may need to be disabled if it interferes with your ability to send email.

If this feature stops working for you, please let us know by posting in our GitHub Discussions or by creating an issue. (Hooking into the email sending web UI is brittle and will sometimes break. Letting us know when that happens is useful and appreciated.)


Enable automatic header anchors.

This is great if you want to put a table of contents or other internal links into your content. Learn about how to use it in the MDH wiki.

It's disabled by default because it creates visual noise in Thunderbird. (And most people probably won't use the feature.)


Enable GFM line breaks.


Hotkey (aka keyboard shortcut)

The MDH hotkey is managed by the browser. It can be edited here:

chrome://extensions/shortcuts

It is currently set to:

Alt+Shift+M``Conflict! Set a new hotkey/shortcut.

Contributing

If you have ever put a code block into an email, then you can help make Markdown Here better. CONTRIBUTING.md

Help make Markdown Here available in your language. Translations are welcome.

Changes saved