vuepress-plugin-abbrlink

A VuePress plugin to generate unique abbreviated links for Markdown files

🏁 Installation

Install the package as a dependency:

pnpm add vuepress-plugin-abbrlink
# or
npm install vuepress-plugin-abbrlink
# or
yarn add vuepress-plugin-abbrlink

🚀 Usage

Add the plugin to your config.js or config.ts file:

module.exports = {
  plugins: [
    [
      'vuepress-plugin-abbrlink',
      {
        paths: 'src/**/*.md',
        alg: 'crc32',
        rep: 'hex',
        timeOffsetInHours: 8,
        fieldName: 'abbrlink',
        drafts: false,
        force: false,
        writeback: true,
        exclude: ['**/README.md']
      }
    ]
  ]
}

🛠️ Options

| Option | Type | Default | Description | |--------|------|---------|-------------| | paths | string | string[] | - | Paths to Markdown files to process (supports glob patterns) | | alg | 'crc32' | 'crc16' | 'crc32' | Algorithm for generating abbrlink | | rep | 'hex' | 'dec' | 'hex' | Representation format (hexadecimal or decimal) | | timeOffsetInHours | number | 8 | Time zone offset in hours | | fieldName | string | 'abbrlink' | Field name in front matter | | drafts | boolean | false | Whether to process draft files | | force | boolean | false | Force mode - regenerate even if abbrlink exists | | writeback | boolean | true | Whether to write changes back to files | | exclude | string | string[] | - | File patterns to exclude (supports glob) |

🔧 Advanced Usage

Using Decimal Format

module.exports = {
  plugins: [
    [
      'vuepress-plugin-abbrlink',
      {
        paths: 'src/**/*.md',
        rep: 'dec'  // Use decimal format
      }
    ]
  ]
}

Custom Field Name

module.exports = {
  plugins: [
    [
      'vuepress-plugin-abbrlink',
      {
        paths: 'src/**/*.md',
        fieldName: 'shortId'  // Use custom field name
      }
    ]
  ]
}

Excluding Files

module.exports = {
  plugins: [
    [
      'vuepress-plugin-abbrlink',
      {
        paths: 'src/**/*.md',
        exclude: ['**/drafts/**', '**/README.md']  // Exclude specific files
      }
    ]
  ]
}

📝 Examples

Input

---
title: Hello World
date: 2023-01-01
---

Hello World!

Output (Default Configuration)

---
title: Hello World
date: 2023-01-01
abbrlink: a1b2c3d4
---

Hello World!

Output (Decimal Format)

---
title: Hello World
date: 2023-01-01
abbrlink: 1690090958
---

Hello World!

Output (Custom Field Name)

---
title: Hello World
date: 2023-01-01
shortId: a1b2c3d4
---

Hello World!

🎯 How It Works

1. The plugin scans the configured Markdown files during VuePress's build process
2. For each file, it checks if the configured field (default: abbrlink) exists
3. If not, it generates a unique abbreviated link based on the file's title and date
4. The link is added to the file's front matter
5. It processes files automatically during VuePress's build process

📦 Compatibility

• VuePress 2.x+
• Node.js 16+

🪪 License

MIT