markdown-it-attrs 使用教程

项目介绍

markdown-it-attrs 是一个基于 markdown-it 的插件，允许用户在 Markdown 内容中设置自定义属性。这个插件非常适合需要在 Markdown 文档中添加额外属性的场景，比如为图片添加 data-fancybox 属性以实现图片放大预览功能。

项目快速启动

安装依赖

首先，你需要安装 markdown-it 和 markdown-it-attrs：

npm install markdown-it markdown-it-custom-attrs

引入插件并配置

在你的项目中引入插件并进行配置：

import MarkdownIt from 'markdown-it';
import mdItCustomAttrs from 'markdown-it-custom-attrs';

const md = new MarkdownIt();
md.use(mdItCustomAttrs, 'image', { 'data-fancybox': "gallery" });

const result = md.render('![图片说明](图片地址)');
console.log(result);

引入图片灯箱 JS 和 CSS 文件

在你的项目中引入 Fancybox 的 JS 和 CSS 文件：

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@fancyapps/ui/dist/fancybox.css" />
<script src="https://cdn.jsdelivr.net/npm/@fancyapps/ui@4.0/dist/fancybox.umd.js"></script>

应用案例和最佳实践

图片放大预览

使用 markdown-it-attrs 插件，你可以轻松实现图片放大预览功能。例如：

![图片说明](图片地址)

渲染后的 HTML 代码会包含 data-fancybox 属性：

<img src="图片地址" alt="图片说明" data-fancybox="gallery">

自定义属性

你还可以为其他元素添加自定义属性，例如：

这是一个带有自定义属性的段落{.custom-class}

渲染后的 HTML 代码会包含 class 属性：

<p class="custom-class">这是一个带有自定义属性的段落</p>

典型生态项目

VitePress

markdown-it-attrs 插件可以与 VitePress 结合使用，为 VitePress 文档中的元素添加自定义属性。以下是一个简单的配置示例：

import { defineConfig } from 'vitepress';
import mdItCustomAttrs from 'markdown-it-custom-attrs';

export default defineConfig({
  markdown: {
    config: (md) => {
      md.use(mdItCustomAttrs, 'image', { 'data-fancybox': "gallery" });
    }
  }
});

通过这种方式，你可以在 VitePress 文档中实现图片放大预览等功能。

---

以上是 markdown-it-attrs 插件的详细使用教程，希望对你有所帮助。