Marked.js 开源项目教程
2024-10-10 09:10:34作者：邓越浪Henry
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 的使用和生态系统。
登录后查看全文
热门项目推荐
相关项目推荐
GLM-5智谱 AI 正式发布 GLM-5，旨在应对复杂系统工程和长时域智能体任务。Jinja00- GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型，也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力，在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同，它能够在一次任务中独立、持续工作超过8小时，期间自主规划、执行、自我进化，最终交付完整的工程级成果。Jinja00
LongCat-AudioDiT-1BLongCat-AudioDiT 是一款基于扩散模型的文本转语音（TTS）模型，代表了当前该领域的最高水平（SOTA），它直接在波形潜空间中进行操作。00- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃，整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展，旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
HY-Embodied-0.5这是一套专为现实世界具身智能打造的基础模型。该系列模型采用创新的混合Transformer（Mixture-of-Transformers, MoT） 架构，通过潜在令牌实现模态特异性计算，显著提升了细粒度感知能力。Jinja00
FreeSql功能强大的对象关系映射（O/RM）组件，支持 .NET Core 2.1+、.NET Framework 4.0+、Xamarin 以及 AOT。C#00
项目优选
收起
kerneldeepin linux kernel
C
27
14
docsOpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
659
4.26 K
RuoYi-Vue3🎉 (RuoYi)官方仓库 基于SpringBoot，Spring Security，JWT，Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.54 K
894
pytorchAscend Extension for PyTorch
Python
503
609
kernelopenEuler内核是openEuler操作系统的核心，既是系统性能与稳定性的基石，也是连接处理器、设备与服务的桥梁。
C
391
286
flutter_flutter暂无简介
Dart
905
218
leetcode🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer（第 2 版）》、《程序员面试金典（第 6 版）》题解
Java
69
21
MindSpeed-LLM昇腾LLM分布式训练框架
Python
142
168
ops-math本项目是CANN提供的数学类基础计算算子库，实现网络在NPU上加速计算。
C++
939
862
cherry-studio🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
1.33 K
108