Copy as Markdown 项目技术文档

Copy as Markdown 项目技术文档

安装指南

Chrome 浏览器安装

1. 打开 Chrome 浏览器。
2. 访问 Chrome Web Store。
3. 点击“添加到 Chrome”按钮。
4. 确认安装，等待安装完成。

Firefox 浏览器安装

1. 打开 Firefox 浏览器。
2. 访问 Firefox Add-ons。
3. 点击“添加到 Firefox”按钮。
4. 确认安装，等待安装完成。

项目的使用说明

功能概述

Copy as Markdown 是一个浏览器扩展，允许用户将网页中的超链接、图片和选中的文本复制为 Markdown 格式。以下是该扩展的主要功能：

• 复制链接、图片和选中文本：支持将网页中的链接、图片和选中的文本复制为 Markdown 格式。
• 链接图片选项：对于链接的图片，可以选择单独复制链接或图片。
• 格式化文本：支持复制 斜体、粗体、~~删除线~~ 和 内联代码 等格式化文本。
• 列表支持：支持无序列表、有序列表和任务列表。
• 表格支持：支持复制表格，并遵循 GitHub Flavored Markdown (GFM) 规范。
• 代码块支持：支持复制代码块，并自动检测语言类型。

使用步骤

1. 在网页中选择需要复制的文本或图片。
2. 右键点击选中的内容，选择“Copy as Markdown”选项。
3. 粘贴到 Markdown 编辑器中即可。

项目API使用文档

权限说明

Copy as Markdown 扩展需要以下权限：

1. contextMenus：用于在右键菜单中显示选项。
2. activeTab：用于访问当前页面的内容。
3. clipboardWrite：用于将数据写入剪贴板（无法读取剪贴板内容）。

已知问题

• Chrome 浏览器：在复制链接和图片时，无法提取图片的 alt 文本或锚点文本内容，而是使用链接本身作为链接标题。Firefox 浏览器没有此限制。

项目安装方式

手动安装（适用于开发者）

1. 克隆项目仓库到本地：

   git clone https://github.com/yorkxin/copy-as-markdown.git
   

2. 进入项目目录：

   cd copy-as-markdown
   

3. 安装依赖：

   npm install
   

4. 构建项目：

   npm run build
   

5. 将构建好的扩展文件加载到浏览器中进行测试。

贡献者

• 灵感来源：@nicolo-ribaudo
• 发布支持：@yakov116

相关项目

• browser-extension-template：一个包含 webpack、选项处理和自动发布的浏览器扩展模板。

许可证

本项目采用 MIT 许可证，版权所有 © 2023 Laxman Damera。