首页
/ Marked.js 开源项目教程

Marked.js 开源项目教程

2024-10-10 08:53:00作者:邓越浪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. 应用案例和最佳实践

应用案例

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

最佳实践

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

4. 典型生态项目

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

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

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
260
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
854
505
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
254
295
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
331
1.08 K
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
397
370
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
kernelkernel
deepin linux kernel
C
21
5