Markdown Here 使用教程

Markdown Here 使用教程

markdown-hereGoogle Chrome, Firefox, and Thunderbird extension that lets you write email in Markdown and render it before sending.项目地址:https://gitcode.com/gh_mirrors/ma/markdown-here

项目介绍

Markdown Here 是一个开源项目，旨在帮助用户在各种邮件客户端（如 Google Chrome、Firefox、Thunderbird 等）中使用 Markdown 语法编写邮件，并在发送前将其渲染为漂亮的 HTML 格式。该项目支持代码块的语法高亮，使得编写包含代码的邮件变得更加方便。此外，Markdown Here 还支持 TeX 公式渲染，非常适合程序员和数学家使用。

项目快速启动

安装

1. 访问 Markdown Here GitHub 页面。
2. 根据你的浏览器类型，下载相应的扩展。
3. 安装扩展后，重启浏览器。

使用

1. 在邮件客户端中新建一封邮件。
2. 使用 Markdown 语法编写邮件内容，例如：

   **你好** `世界`
   

   alert('Hello, 语法高亮!');
   

3. 在邮件编辑区域右键点击，选择 "Markdown Toggle" 选项，或者点击地址栏中的按钮。
4. 你的邮件内容将会被渲染成 HTML 格式。
5. 发送邮件。

应用案例和最佳实践

案例一：程序员邮件

程序员经常需要在邮件中包含代码片段，使用 Markdown Here 可以轻松实现代码高亮，提高邮件的可读性。例如：

这是一个 Python 代码示例：

```python
def hello_world():
    print("Hello, World!")

### 案例二：数学公式

数学家或科研人员可以在邮件中包含复杂的数学公式，Markdown Here 支持 TeX 语法，例如：

```markdown
这是一个数学公式示例：

$$
E=mc^2
$$

最佳实践

• 保持简洁：尽量使用简洁的 Markdown 语法，避免过度复杂的格式。
• 代码块使用：在包含代码的邮件中，使用代码块并指定语言，以便正确高亮。
• 预览检查：在发送前，多次使用 "Markdown Toggle" 功能预览邮件，确保渲染效果符合预期。

典型生态项目

1. marked

Markdown Here 使用 marked 项目进行 Markdown 到 HTML 的转换。marked 是一个快速的 Markdown 解析器和编译器，支持 GFM（GitHub Flavored Markdown）。

2. highlight.js

Markdown Here 使用 highlight.js 进行代码块的语法高亮。highlight.js 支持多种编程语言，能够自动检测语言并进行高亮。

3. jsHtmlToText

Markdown Here 使用 jsHtmlToText 将 HTML 转换为纯文本。这个工具在需要纯文本格式的场景中非常有用。

通过这些生态项目的支持，Markdown Here 提供了强大的功能，使得在邮件中使用 Markdown 变得更加便捷和高效。

markdown-hereGoogle Chrome, Firefox, and Thunderbird extension that lets you write email in Markdown and render it before sending.项目地址:https://gitcode.com/gh_mirrors/ma/markdown-here