markdownReader 安装和配置指南

markdownReader 安装和配置指南

markdownReader markdownReader is a extention for chrome, used for reading markdown file. 项目地址: https://gitcode.com/gh_mirrors/ma/markdownReader

1. 项目基础介绍和主要编程语言

项目基础介绍

markdownReader 是一个用于 Chrome 浏览器的扩展程序，专门用于阅读 Markdown 文件。它支持自动重新加载本地文件、代码高亮、显示内容大纲等功能，并且支持多种 Markdown 扩展，如任务列表、表格和 LaTeX 公式。

主要编程语言

该项目主要使用以下编程语言：

• JavaScript
• CSS

2. 项目使用的关键技术和框架

关键技术和框架

• showdown.js: 用于将 Markdown 转换为 HTML。
• KaTeX: 用于渲染 LaTeX 公式。
• highlight.js: 用于代码高亮。

3. 项目安装和配置的准备工作和详细安装步骤

准备工作

1. 安装 Chrome 浏览器: 确保你已经安装了最新版本的 Chrome 浏览器。
2. 下载项目代码: 你可以通过以下命令从 GitHub 下载项目代码：

   git clone https://github.com/yaniswang/markdownReader.git
   

详细安装步骤

步骤 1: 下载并解压项目

1. 打开终端或命令提示符。
2. 运行以下命令下载项目代码：

   git clone https://github.com/yaniswang/markdownReader.git
   

3. 进入项目目录：

   cd markdownReader
   

步骤 2: 加载扩展程序到 Chrome

1. 打开 Chrome 浏览器，输入 chrome://extensions/ 并按回车。
2. 在右上角打开“开发者模式”。
3. 点击“加载已解压的扩展程序”按钮。
4. 选择你刚刚下载并解压的 markdownReader 目录。

步骤 3: 配置扩展程序

1. 确保扩展程序已启用。
2. 在 Chrome 扩展程序页面，找到 markdownReader 扩展程序，点击“详细信息”。
3. 在“允许访问文件网址”选项中，确保该选项已启用。

步骤 4: 使用扩展程序

1. 打开 Chrome 浏览器，拖动一个 Markdown 文件（.md 文件）到浏览器窗口中。
2. markdownReader 将自动加载并显示该文件的内容。

注意事项

• 如果你在本地编辑 Markdown 文件，保存后浏览器会自动重新加载文件内容。
• 你可以通过双击页面来切换原始 Markdown 模式和渲染后的 HTML 模式。

通过以上步骤，你已经成功安装并配置了 markdownReader 扩展程序，可以开始使用它来阅读和编辑 Markdown 文件了。

markdownReader markdownReader is a extention for chrome, used for reading markdown file. 项目地址: https://gitcode.com/gh_mirrors/ma/markdownReader