rehype-smart-links

为你的Markdown链接添加智能导航和样式，轻松区分内部链接、断开链接和外部链接。

查看演示

了解更多

GitHub

主要特性

智能链接分类

自动识别和区分内部链接、断开链接和外部链接，提升导航体验。

断开链接检测

自动检测站内断开的链接，防止用户访问不存在的页面，提高用户体验。

自定义样式

为不同类型的链接应用自定义样式，提升用户体验，使你的文档更加易于访问和视觉吸引力。

快速安装

使用你喜欢的包管理器安装：

# 使用 npm
npm install rehype-smart-links

# 使用 yarn
yarn add rehype-smart-links

# 使用 pnpm
pnpm add rehype-smart-links

在 Astro 中使用

在你的 `astro.config.mjs` 文件中添加插件：

import { defineConfig } from 'astro/config';
import rehypeSmartLinks from 'rehype-smart-links';

export default defineConfig({
  markdown: {
    rehypePlugins: [[rehypeSmartLinks, {
      // 你的配置选项
      internalLinkClass: 'internal-link',
      brokenLinkClass: 'broken-link',
      externalLinkClass: 'external-link'
    }]]
  }
});

兼容框架

rehype-smart-links 可以与任何使用 rehype 处理 Markdown 的框架一起使用：

Next.js

与使用 MDX 的 Next.js 应用程序无缝协作

Gatsby

集成到 Gatsby 的 markdown 处理流程中

Docusaurus

非常适合用 Docusaurus 构建的文档站点

想了解更多？

查看关于页面了解更多关于如何使用和配置插件的信息。