showdown实现markdown预览功能

Showdown.js 简介

Showdown.js 是一个JavaScript库,用于将Markdown文本转换为HTML。由于其轻量级和易于使用的特性,它广泛应用于需要Markdown渲染的前端项目中。

安装 Showdown.js

Showdown.js 可以通过npm或直接通过脚本标签引入到项目中。

通过 NPM 安装

npm install showdown

通过脚本标签引入

<script src="https://cdn.jsdelivr.net/npm/showdown@1.9.1/dist/showdown.min.js"></script>

基本使用

一旦安装了Showdown.js,就可以创建一个转换器实例,并用它来将Markdown转换为HTML。

示例代码

// 引入 Showdown
const showdown = require('showdown');

// 创建转换器实例
const converter = new showdown.Converter();

// Markdown 文本
const markdown = '# 标题\n\n这是一段**粗体**文本。';

// 转换为 HTML
const html = converter.makeHtml(markdown);

console.log(html);

高级配置

Showdown.js 支持多种配置选项,可以用来调整Markdown到HTML的转换过程。

示例:启用表格

// 配置转换器以支持Markdown表格
converter.setOption('tables', true);

// 包含表格的Markdown文本
const markdownWithTable = '| 标题1 | 标题2 |\n|-------|-------|\n| 单元格1 | 单元格2 |';

// 转换为 HTML
const htmlWithTable = converter.makeHtml(markdownWithTable);

console.log(htmlWithTable);

Markdown 扩展

Showdown.js 允许开发者通过扩展来增加新的Markdown语法或修改现有的渲染规则。

示例:创建自定义扩展

// 自定义扩展,用于将 @@ 包围的文本转换为红色
const myExtension = () => {
  return [{
    type: 'lang',
    filter: function (text) {
      return text.replace(/@@(.+?)@@/g, '<span style="color: red;">$1</span>');
    }
  }];
};

// 向转换器添加扩展
converter.addExtension(myExtension, 'myExtension');

// 包含自定义语法的Markdown文本
const customMarkdown = '这是一段@@红色@@文本。';

// 转换为 HTML
const customHtml = converter.makeHtml(customMarkdown);

console.log(customHtml);

Showdown.js 与前端框架集成

Showdown.js 可以轻松集成到流行的前端框架,如React或Vue中,用于动态渲染Markdown内容。

React 示例

import React, { useState } from 'react';
import showdown from 'showdown';

const MarkdownEditor = () => {
  const [markdown, setMarkdown] = useState('');
  const converter = new showdown.Converter();

  return (
    <div>
      <textarea
        onChange={(e) => setMarkdown(e.target.value)}
        placeholder="输入Markdown文本"
      />
      <div
        dangerouslySetInnerHTML={{ __html: converter.makeHtml(markdown) }}
      />
    </div>
  );
};

export default MarkdownEditor;

结论

Showdown.js 是一个功能强大且灵活的库,适用于将Markdown转换为HTML的任何场景。通过其简单的API和丰富的配置选项,Showdown.js 成为前端开发者处理Markdown的首选工具。

原文链接:https://juejin.cn/post/7329718699341512730 作者:慕仲卿

(0)
上一篇 2024年1月30日 下午4:16
下一篇 2024年1月30日 下午4:27

相关推荐

发表回复

登录后才能评论