Replace Assets New
Overview
This feature is powered by the @vuepress/plugin-replace-assets plugin.
It replaces local asset links within the site, such as images, videos, audio, PDFs, and other resources, rewriting local asset paths to new addresses.
Why is this feature needed?
Many users choose to store site assets on CDN services to accelerate site access and improve availability.
In this process, assets typically need to be uploaded to the CDN service first, then CDN links are obtained, and finally used in the site content.
This may seem straightforward, but in practice, it often requires repeatedly performing:
Upload assets → Get asset links → Use full asset links in contentDuring this process, content creation is frequently interrupted.
This feature aims to solve this problem. During content creation, you only need to use local asset paths directly, and the theme will handle the asset path replacement at the appropriate stage.
This feature does not modify source files; replacements are only made in the compiled content.
Usage
The feature is disabled by default in the theme. You can enable it in the configuration:
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
theme: plumeTheme({
// ReplaceAssetsPluginOptions
replaceAssets: 'https://cdn.example.com'
})
})It's recommended to enable asset path replacement only for production builds, using local asset paths directly during development
import process from 'node:process'
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
const isProd = process.env.NODE_ENV === 'production'
export default defineUserConfig({
theme: plumeTheme({
// Enable only in production environment
replaceAssets: isProd ? 'https://cdn.example.com' : false
})
})Asset Management
You should store assets in the .vuepress/public directory:
./docs
├── .vuepress
│ └── public
│ ├── images
│ │ ├── foo.jpg
│ │ └── bar.jpg
│ └── medias
│ └── foo.mp4
└── README.mdWhy store assets in this directory?
When the site is compiled and ready for deployment, we can easily upload files from this directory directly to the CDN.
In markdown, use local asset paths directly:
<img src="/images/foo.jpg">In javascript:
const foo = '/images/foo.jpg'
const img = document.createElement('img')
img.src = '/images/foo.jpg'And in style files:
.foo {
background: url('/images/foo.jpg');
}The plugin will correctly identify these assets and replace them in the compiled content.
The plugin does not support identifying concatenated paths like '/images/' + 'foo.jpg'.
Configuration Reference
/**
* Asset link replacement configuration
*/
type ReplaceAssetsPluginOptions
= | Replacement
| ReplacementRule
| ReplacementRule[]
| ReplaceAssetsOptions
/**
* - `string`: Prepended to the original asset link
* - `function`: Returns the replaced asset link
*/
type Replacement = string | ((url: string) => string)
interface ReplacementRule {
/**
* Match asset links
*/
find: RegExp | string
/**
* Asset link replacement
*/
replacement: Replacement
}
interface ReplaceAssetsOptions {
/**
* Custom asset replacement rules
*/
rules?: ReplacementRule | ReplacementRule[]
/**
* Replacement for built-in asset matching rules
*/
all?: Replacement
/**
* Replacement for built-in image asset matching rules
*/
image?: Replacement
/**
* Replacement for built-in media asset matching rules
*/
media?: Replacement
}Built-in Asset Matching Rules
For convenience, the theme plugin provides built-in asset matching rules that you can use directly.
image: Finds image assets, including local image resource links with formats['apng','bmp','png','jpeg','jpg','jfif','pjpeg','pjp','gif','svg','ico','webp','avif','cur','jxl']media: Finds media assets, including local media resource links with formats['mp4','webm','ogg','mp3','wav','flac','aac','opus','mov','m4a','vtt','pdf']all: Finds both image and media assets, combining bothimageandmediarules
When directly passing a asset link prefix or asset link replacement function, the theme uses the all rule to replace asset links.
import process from 'node:process'
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
theme: plumeTheme({
// replaceAssets: 'https://cdn.example.com'
replaceAssets: url => `https://cdn.example.com${url}`
})
})You can also apply different asset link prefixes or replacement functions to different built-in rules:
import process from 'node:process'
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
theme: plumeTheme({
// replaceAssets: {
// image: 'https://image.cdn.com/',
// media: 'https://media.cdn.com/'
// },
replaceAssets: {
image: url => `https://image.cdn.com${url}`,
media: url => `https://media.cdn.com${url}`
}
})
})Custom Asset Matching Rules
You can also define custom asset matching rules:
import process from 'node:process'
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
theme: plumeTheme({
replaceAssets: {
find: /^\/images\/.*\.(jpg|jpeg|png|gif|svg|webp|avif)$/,
replacement: url => `https://image.cdn.com${url}`
}
})
})You can also define multiple matching rules:
import process from 'node:process'
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
theme: plumeTheme({
replaceAssets: [
// Find image assets
{
find: /^\/images\/.*\.(jpg|jpeg|png|gif|svg|webp|avif)$/,
replacement: 'https://image.cdn.com'
},
// Find media assets
{
find: /^\/medias\/.*\.(mp4|webm|ogg|mp3|wav|flac|aac|m3u8|m3u|flv|pdf)$/,
replacement: url => `https://media.cdn.com${url}`
},
]
})
})find Field Explanation
The find field is used to match asset links and can be a regular expression or string.
When a string is provided, if it starts with ^ or ends with $, it will be automatically converted to a regular expression. Otherwise, it will check if the asset link ends with find or starts with find.
'^/images/foo.jpg' -> /^\/images\/foo.jpg/
'/images/foo.jpg$' -> /^\/images\/foo.jpg$/All matched asset paths start with /.
Contributors
Changelog
38505-on