推荐使用 markdown-js 库,它是一个开源的 JavaScript 库,支持将 Markdown 格式转换为 HTML 格式。以下是详细的使用说明:
1. GitHub 地址2. 基本用法(Node.js 环境)- 步骤 1:新建一个 .js 文件(如 convert.js),粘贴以下代码:var markdown = require("markdown").markdown;console.log(markdown.toHTML("Hello *World*!"));
- 步骤 2:通过 Node.js 执行该文件:node convert.js
- 输出结果:<p>Hello <em>World</em>!</p>
3. 浏览器端使用- 步骤 1:创建一个 HTML 文件(如 index.html),粘贴以下代码:<!DOCTYPE html><html><body> <textarea id="text-input" oninput="this.editor.update()" rows="6" cols="60">Type Markdown here.</textarea> <div id="preview"></div> <script src="../node_modules/markdown/lib/markdown.js"></script> <script> function Editor(input, preview) { this.update = function () { preview.innerHTML = markdown.toHTML(input.value); }; input.editor = this; this.update(); } var $ = function (id) { return document.getElementById(id); }; new Editor($("text-input"), $("preview")); </script></body></html>
- 步骤 2:用浏览器打开该文件,输入 Markdown 内容后,下方会实时显示转换后的 HTML 效果。
4. 功能特点- 轻量级:纯 JavaScript 实现,无依赖。
- 双向支持:兼容 Node.js 和浏览器环境。
- 实时转换:通过监听输入事件(如 oninput)实现动态更新。
5. 注意事项- 确保已通过 npm install markdown 安装库文件。
- 浏览器中使用时,需正确引入 markdown.js 的路径(如示例中的 ../node_modules/...)。
6. 扩展建议- 如需更复杂的功能(如表格、代码高亮),可结合其他库(如 marked 或 showdown)。
- 关注公众号“汪子熙”获取更多原创技术文章(非强制,仅供参考)。
总结:markdown-js 是一个简单易用的 Markdown 转 HTML 工具,适合快速集成到项目或学习用途。如需生产环境使用,建议评估其维护状态(最后一次更新为较早时间)或选择更活跃的替代库(如 marked)。