Community Plugin

gatsby-plugin-abbrlink

A Gatsby plugin to generate unique abbreviated links for Markdown files

🏁 Installation

Install the package as a dependency:

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

🚀 Usage

Add it to your plugins in gatsby-config.js:

module.exports = {
  plugins: [
    {
      resolve: 'gatsby-plugin-abbrlink',
      options: {
        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

{
  resolve: 'gatsby-plugin-abbrlink',
  options: {
    paths: 'src/**/*.md',
    rep: 'dec'  // Use decimal format
  }
}

Custom Field Name

{
  resolve: 'gatsby-plugin-abbrlink',
  options: {
    paths: 'src/**/*.md',
    fieldName: 'shortId'  // Use custom field name
  }
}

Excluding Files

{
  resolve: 'gatsby-plugin-abbrlink',
  options: {
    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

The plugin scans the configured Markdown files during the Gatsby bootstrap process
For each file, it checks if the configured field (default: abbrlink) exists
If not, it generates a unique abbreviated link based on the file’s title and date
The link is added to the file’s front matter
It watches for file changes and updates links automatically during development

📦 Compatibility

Gatsby 4.x+
Node.js 16+

🪪 License

MIT