Marked.js 常见问题解决方案

Marked.js 常见问题解决方案

marked A markdown parser and compiler. Built for speed. 项目地址: https://gitcode.com/gh_mirrors/ma/marked

项目基础介绍

Marked.js 是一个用于解析和编译 Markdown 的 JavaScript 库，旨在提供高速的 Markdown 解析和编译功能。它是一个轻量级的库，支持多种 Markdown 语法和规范，并且可以在浏览器、服务器或命令行界面（CLI）中使用。Marked.js 的主要编程语言是 JavaScript。

新手使用注意事项及解决方案

1. 输出 HTML 的安全性问题

问题描述：
Marked.js 默认不会对生成的 HTML 进行安全处理，这可能导致 XSS（跨站脚本攻击）等安全问题。

解决步骤：

1. 安装 DOMPurify 库：
   在使用 Marked.js 生成 HTML 之前，建议安装并使用 DOMPurify 库来净化生成的 HTML。可以通过 npm 安装 DOMPurify：

   npm install dompurify
   

2. 使用 DOMPurify 净化 HTML：
   在生成 HTML 后，使用 DOMPurify 进行净化处理：

   const createDOMPurify = require('dompurify');
   const { JSDOM } = require('jsdom');
   const window = new JSDOM('').window;
   const DOMPurify = createDOMPurify(window);
   
   const marked = require('marked');
   const dirtyHtml = marked.parse('# Hello, world!');
   const cleanHtml = DOMPurify.sanitize(dirtyHtml);
   

2. 浏览器兼容性问题

问题描述：
Marked.js 不支持 IE11 浏览器，可能会导致在某些旧版浏览器中无法正常工作。

解决步骤：

1. 检测浏览器版本：
   在使用 Marked.js 之前，可以通过 JavaScript 检测用户浏览器的版本，如果检测到是 IE11 或更早版本，可以提示用户升级浏览器或使用其他浏览器。

2. 提供替代方案：
   如果用户必须使用 IE11，可以考虑使用其他支持 IE11 的 Markdown 解析库，或者提供一个降级方案，例如使用纯文本显示 Markdown 内容。

3. 命令行工具的使用问题

问题描述：
新手在使用 Marked.js 的命令行工具时，可能会遇到安装或使用上的问题。

解决步骤：

1. 全局安装 Marked.js：
   确保已经全局安装了 Marked.js 的命令行工具：

   npm install -g marked
   

2. 使用命令行工具：
   安装完成后，可以通过命令行工具解析 Markdown 文件：

   marked -i input.md -o output.html
   

3. 查看帮助文档：
   如果遇到问题，可以通过以下命令查看帮助文档：

   marked --help
   

通过以上步骤，新手可以更好地使用 Marked.js 项目，并解决常见的问题。

marked A markdown parser and compiler. Built for speed. 项目地址: https://gitcode.com/gh_mirrors/ma/marked