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

登录后查看全文

最新内容推荐

【亲测免费】 Tower：开源无人机地面控制站应用【免费下载】精简版SQL2014下载【免费下载】 Altium Designer 常用库文件基于STM32单片机的DHT11温湿度传感器+OLED显示程序【免费下载】 EPLAN Fluid 1.8.4 液压气动符号库【免费下载】 SM2246系列量产工具开卡工具包 YOLOV8源码解读：深入细节的物体检测之旅【免费下载】 IE8浏览器离线安装包【亲测免费】 Unity读取Word、Excel、PDF、PPT资源文件【亲测免费】向日葵ARM版安装包及说明

项目优选

收起

deepin linux kernel

OpenHarmony documentation | OpenHarmony开发者文档

Ascend Extension for PyTorch

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

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

flutter_flutter

ohos_react_native

React Native鸿蒙化仓库

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

🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer（第 2 版）》、《程序员面试金典（第 6 版）》题解

cangjie_compiler

仓颉编译器源码及 cjdb 调试工具。