Marked.js 开源项目教程

2024-10-10 08:53:00作者：邓越浪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 freeCodeCamp音乐播放器项目中的函数调用问题解析 2 freeCodeCamp论坛排行榜项目中的错误日志规范要求 3 freeCodeCamp猫照片应用教程中的HTML注释测试问题分析 4 freeCodeCamp JavaScript高阶函数中的对象引用陷阱解析 5 freeCodeCamp全栈开发课程中React实验项目的分类修正 6 freeCodeCamp课程视频测验中的Tab键导航问题解析 7 freeCodeCamp全栈开发课程中React组件导出方式的衔接问题分析 8 freeCodeCamp英语课程视频测验选项与提示不匹配问题分析 9 freeCodeCamp课程页面空白问题的技术分析与解决方案 10 freeCodeCamp博客页面工作坊中的断言方法优化建议

最新内容推荐

PCDViewer-4.9.0-Ubuntu20.04：专业点云可视化与编辑工具全面解析 JDK 8u381 Windows x64 安装包：企业级Java开发环境的完美选择 SAP S4HANA物料管理资源全面解析：从入门到精通的完整指南 VSdebugChkMatch.exe：专业PDB签名匹配工具全面解析与使用指南基恩士LJ-X8000A开发版SDK样本程序全面指南 - 工业激光轮廓仪开发利器 ZLIB 1.3 静态库 Windows x64 版本：高效数据压缩解决方案完全指南 SteamVR 1.2.3 Unity插件：兼容Unity 2019及更低版本的VR开发终极解决方案全球GEOJSON地理数据资源下载指南 - 高效获取地理空间数据的完整解决方案 LabVIEW串口通信开发全攻略：从入门到精通的完整解决方案 Windows版Redis 5.0.14下载资源：高效内存数据库的完美Windows解决方案

项目优选

收起

OpenHarmony documentation | OpenHarmony开发者文档

deepin linux kernel

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台，包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分，采用java语言实现，可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用

ohos_react_native

React Native鸿蒙化仓库

🎉 (RuoYi)官方仓库基于SpringBoot，Spring Security，JWT，Vue3 & Vite、Element Plus 的前后端分离权限管理系统

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件，通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求，让密码技术应用更简单，同时探索后量子等先进算法创新实践，构建密码前沿技术底座！

openGauss-server

openGauss kernel ~ openGauss is an open source relational database management system

金融AI编程实战

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制，新手友好，让学生以亲身实践开源开发的方式，学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线，涉及 Bash、Python、SQL、BI、AI 等全技术栈，培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。

Jupyter Notebook

Cangjie-Examples

本仓将收集和展示高质量的仓颉示例代码，欢迎大家投稿，让全世界看到您的妙趣设计，也让更多人通过您的编码理解和喜爱仓颉语言。

Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...