Marked 开源项目教程

2024-08-11 16:26:22作者：范靓好Udolf

项目介绍

Marked 是一个用于解析 Markdown 的低级编译器，旨在快速且轻量级地实现所有支持的 Markdown 风格和规范。它可以在浏览器、服务器或命令行接口（CLI）中运行。Marked 不使用缓存，也不会长时间阻塞，确保了高效的解析性能。

项目快速启动

安装

通过 npm 安装

npm install -g marked

在浏览器中使用

<!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>

使用 CLI

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

应用案例和最佳实践

案例一：静态博客生成器

使用 Marked 可以轻松地将 Markdown 文件转换为 HTML，适用于构建静态博客。以下是一个简单的示例：

const fs = require('fs');
const marked = require('marked');

fs.readFile('post.md', 'utf8', (err, data) => {
  if (err) throw err;
  const html = marked.parse(data);
  fs.writeFile('post.html', html, (err) => {
    if (err) throw err;
    console.log('Post has been converted to HTML!');
  });
});

最佳实践

安全使用：由于 Marked 不 sanitize 输出 HTML，建议使用 DOMPurify 等库来处理输出，以防止 XSS 攻击。

const DOMPurify = require('dompurify');
const marked = require('marked');

const dirty = marked.parse(`<img src="x" onerror="alert('not happening')">`);
const clean = DOMPurify.sanitize(dirty);

典型生态项目

1. Gatsby

Gatsby 是一个基于 React 的静态站点生成器，可以使用 Marked 作为其 Markdown 解析器，提供快速且高效的静态站点构建体验。

2. Hexo

Hexo 是一个快速、简洁且高效的博客框架，支持使用 Marked 进行 Markdown 解析，适用于快速搭建个人博客。

3. VuePress

VuePress 是一个基于 Vue 的静态站点生成器，特别适合构建文档网站。它可以集成 Marked 来处理 Markdown 内容，提供流畅的阅读体验。

通过以上教程，您可以快速上手并深入了解 Marked 开源项目的使用和生态。希望这些内容对您有所帮助！

热门内容推荐

1 开源项目 developer-roadmap 使用教程 2 开发者路线图项目教程 3 开源项目教程：awesome-selfhosted 4 开源项目 `awesome-selfhosted` 使用教程 5 Vue.js 教程与指南 6 Vue.js 项目教程 7 探索Vue 2的持久魅力：一个开源项目的深度解析 8 TensorFlow 开源项目教程 9 TensorFlow：开启机器学习新纪元 10 TensorFlow 开源项目指南

最新内容推荐

《深入掌握OpenPTrack：安装与实战指南》《C++操作符库taocpp/operators安装与使用教程》探索三维世界：cpu_tsdf开源项目的安装与使用教程《稳健点集配准算法GMMReg的安装与使用教程》《SoftModem：开源的Arduino与手机通信解决方案》《moc-ng：Qt的moc替代工具的安装与使用教程》《MaNGOS开源项目安装与使用指南》《Tracey的安装与使用教程》深入探索Vireio Perception：安装与使用教程 gason：轻量级JSON解析库的安装与使用教程

项目优选

收起

Python-100-Days

Python - 100天从新手到大师

Cangjie-Examples

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

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

RuoYi-Cloud-Vue3

🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统

HarmonyOS-Examples

本仓将收集和展示仓颉鸿蒙应用示例代码，欢迎大家投稿，在仓颉鸿蒙社区展现你的妙趣设计！

面向全场景的 Java 企业级插件化编程框架，支持聚散部署和共享内存，以一切皆可替换为核心理念，旨在为用户提供一种灵活的服务开发范式。

Java开发视觉智能识别项目纯java 调用 yolo onnx 模型 AI 视频识别支持 yolov5 yolov8 yolov7 yolov9 yolov10,yolov11,paddle ,obb,seg ,detection，包含预处理和后处理。java 目标检测目标识别，可集成 rtsp rtmp，车牌识别，人脸识别，跌倒识别，打架识别，车牌识别，人脸识别等

a fast，lightweight and joy web framework

这是一个人工生命试验项目，最终目标是创建“有自我意识表现”的模拟生命体。

✍ WeChat Markdown Editor | 一款高度简洁的微信 Markdown 编辑器：支持 Markdown 语法、色盘取色、多图上传、一键下载文档、自定义 CSS 样式、一键重置等特性