Marked.js 开源项目教程

2024-10-10 05:44:19作者：邓越浪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 开发者路线图项目教程 2 开源项目 developer-roadmap 使用教程 3 Vue.js 教程与指南 4 Vue.js 项目教程 5 探索Vue 2的持久魅力：一个开源项目的深度解析 6 开源项目教程：awesome-selfhosted 7 开源项目 `awesome-selfhosted` 使用教程 8 TensorFlow 开源项目指南 9 TensorFlow 开源项目教程 10 TensorFlow：开启机器学习新纪元

最新内容推荐

在Docker容器中运行Windows：一个强大的开源解决方案 Sprytile 项目常见问题解决方案开源项目async-rl常见问题解决方案 PyPSA 开源项目常见问题解决方案开源项目 smart_login 常见问题解决方案 Criollo 开源项目推荐 NATS JWT 项目使用教程 RouteConverter 开源项目教程 YouKuDownLoader 项目安装与使用教程 jQuery Mouse Wheel 插件使用教程

项目优选

收起

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

CangjieCommunity

为仓颉编程语言开发者打造活跃、开放、高质量的社区环境

Advanced-Java是一个Java进阶教程，适合用于学习Java高级特性和编程技巧。特点：内容深入、实例丰富、适合进阶学习。

仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义，支持RESP2和RESP3协议，支持发布订阅模式，支持哨兵模式和集群模式。

强大的敏感信息搜索工具

🎉 基于SpringBoot，Spring Security，JWT，Vue & Element 的前后端分离权限管理系统，同时提供了 Vue3 的版本

杨帆测试平台

扬帆测试平台是一款高效、可靠的自动化测试平台，旨在帮助团队提升测试效率、降低测试成本。该平台包括用例管理、定时任务、执行记录等功能模块，支持多种类型的测试用例，目前支持API(http和grpc协议)、性能、CI调用等功能，并且可定制化，灵活满足不同场景的需求。其中，支持批量执行、并发执行等高级功能。通过用例设置，可以设置用例的基本信息、运行配置、环境变量等，灵活控制用例的执行。

Yi Coder 编程模型，小而强大的编程助手

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

为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers