Marked.js 开源项目教程

2024-10-10 09:10:34作者：邓越浪Henry

A markdown parser and compiler. Built for speed.

项目地址：https://gitcode.com/gh_mirrors/ma/marked

1. 项目介绍

Marked.js 是一个快速、轻量级的 Markdown 解析器和编译器，专为速度而设计。它能够在不使用缓存或长时间阻塞的情况下解析 Markdown 内容，并且支持多种 Markdown 风格和规范。Marked.js 可以在浏览器、服务器或命令行界面（CLI）中使用，适用于各种应用场景。

2. 项目快速启动

安装

命令行安装

npm install -g marked

浏览器中使用

npm install marked

使用示例

命令行使用

# 示例：使用标准输入
$ marked -o hello.html
hello world
^D
$ cat hello.html
<p>hello world</p>

浏览器中使用

<!doctype html>
<html>
<head>
  <meta charset="utf-8"/>
  <title>Marked in the browser</title>
</head>
<body>
  <div id="content"></div>
  <script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
  <script>
    document.getElementById('content').innerHTML = marked.parse('# Marked in the browser\n\nRendered by **marked**.');
  </script>
</body>
</html>

ESM 模块导入

<script type="module">
  import { marked } from "https://cdn.jsdelivr.net/npm/marked/lib/marked.esm.js";
  document.getElementById('content').innerHTML = marked.parse('# Marked in the browser\n\nRendered by **marked**.');
</script>

3. 应用案例和最佳实践

应用案例

静态网站生成器：Marked.js 可以用于将 Markdown 文件转换为 HTML，适用于静态网站生成器，如 Jekyll 或 Hugo。
博客平台：许多博客平台使用 Marked.js 来解析用户提交的 Markdown 内容，并将其转换为可读的 HTML 格式。
文档生成：Marked.js 可以用于生成项目文档，将 Markdown 格式的文档转换为 HTML 以便在线查看。

最佳实践

安全使用：由于 Marked.js 不进行 HTML 输出净化，建议在使用时结合 DOMPurify 等库进行安全处理。
性能优化：在处理大量 Markdown 内容时，可以考虑使用缓存机制来提高性能。
自定义扩展：Marked.js 支持扩展，可以根据项目需求自定义解析规则和输出格式。

4. 典型生态项目

DOMPurify：用于净化 Marked.js 生成的 HTML 输出，防止 XSS 攻击。
Highlight.js：用于在 Marked.js 生成的 HTML 中高亮显示代码块。
Markdown-it：另一个流行的 Markdown 解析器，与 Marked.js 类似，但提供了更多的插件和扩展功能。

通过以上内容，您可以快速上手并深入了解 Marked.js 的使用和生态系统。

A markdown parser and compiler. Built for speed.

项目地址：https://gitcode.com/gh_mirrors/ma/marked

登录后查看全文

热门内容推荐

1 编程实践项目探索指南：从零构建技术能力体系 2 技术解构式学习：从0到1构建你的编程知识体系 3 构建自己的技术世界：build-your-own-x项目的实践探索指南 4 解锁编程技能的实践之旅：从零构建你的技术世界 5 技术实践探索：从零开始构建核心系统的实践指南 6 亲手锻造技术引擎：从0到1构建核心系统的实践指南

最新内容推荐

AcFunDown视频下载工具完全指南还在为数字笔记抓狂？这款开源神器让手写批注效率提升300%Windows笔记本电池健康管理全指南：从根源解决电池损耗问题 gmx_MMPBSA分子间相互作用索引错误的深度诊断与解决 Axure RP 11 本地化方案：Mac中文界面优化与原型设计工具汉化全指南如何高效获取教育资源？这款工具让教材下载效率提升80%视频元数据深度编辑：专业技巧与案例网盘直链下载技术解析与应用指南如何用DeepSeek-R1推理模型提升复杂任务解决能力：完整指南 5个突破瓶颈技巧：硬件优化工具让你的电脑性能提升30%

项目优选

收起

deepin linux kernel

openEuler内核是openEuler操作系统的核心，既是系统性能与稳定性的基石，也是连接处理器、设备与服务的桥梁。

Ascend Extension for PyTorch

ops-transformer

本项目是CANN提供的transformer类大模型算子库，实现网络在NPU上加速计算。

本项目是CANN提供的神经网络类计算算子库，实现网络在NPU上加速计算。

昇腾LLM分布式训练框架

本项目是CANN提供的数学类基础计算算子库，实现网络在NPU上加速计算。

flutter_flutter

本仓库是 Flutter SDK 与 Flutter Engine 的 OpenHarmony 适配版本，由 CPF-Flutter 团队维护。开发者可使用熟悉的 Flutter 技术栈开发 OpenHarmony 应用，3.35.7 及以后的适配版本可基于本仓库源码构建支持 OpenHarmony 的 Flutter Engine。

Oohos_react_native

React Native鸿蒙化仓库