在使用VitePress构建静态网站时,实现清洁URL(即不包含.html
扩展名的URL)可以提升用户体验和网站的美观度。然而,要实现这一点,通常需要服务器端的支持。本文将介绍如何在VitePress中配置清洁URL,并提供实例代码和解释说明。
一、VitePress默认行为与清洁URL需求
VitePress默认会将入站链接解析为以.html
结尾的URL。例如,如果你的Markdown文件名为getting-started.md
,VitePress会将其生成为getting-started.html
,并通过该URL进行访问。然而,许多用户更喜欢没有.html
扩展名的清洁URL,如example.com/path
而不是example.com/path.html
。
二、服务器支持清洁URL
要实现清洁URL,首先需要你的服务器或托管平台支持将如/foo
的URL映射到/foo.html
(如果存在的话),而不需要进行重定向。以下是一些常见服务器或托管平台的支持情况:
- Netlify和GitHub Pages:默认支持清洁URL。
- Vercel:需要在
vercel.json
中启用cleanUrls
选项。
如果你的服务器或托管平台支持这一功能,你可以进一步在VitePress中启用cleanUrls
配置选项,以实现以下效果:
- 页面之间的入站链接将生成不带
.html
扩展名的URL。 - 如果当前路径以
.html
结尾,路由器将执行客户端重定向到无扩展名的路径。
三、VitePress配置清洁URL
要在VitePress中启用清洁URL,你需要在.vitepress/config.js
文件中进行配置。以下是一个配置示例:
// .vitepress/config.js
module.exports = {
// 其他配置项...
cleanUrls: true, // 启用清洁URL
};
启用该选项后,VitePress将按照清洁URL的方式生成页面链接。
四、无法配置服务器支持时的解决方案
如果你的服务器或托管平台不支持清洁URL的映射,你将需要手动调整目录结构和Markdown文件的命名。以下是一个推荐的目录结构示例:
.
├─ getting-started
│ └─ index.md // 该文件将生成 getting-started/index.html,但可通过 /getting-started 访问(如果服务器支持)
├─ installation
│ └─ index.md // 同上,生成 installation/index.html,可通过 /installation 访问
└─ index.md // 首页,生成 index.html,可通过 / 访问
在这种结构下,即使服务器不支持清洁URL的映射,你也可以通过命名和目录结构来模拟出类似的效果。但请注意,这种方式并不是真正的清洁URL,因为实际上生成的文件仍然包含.html
扩展名。只是在访问时,用户可以省略该扩展名(如果服务器支持的话)。
五、总结
在VitePress中实现清洁URL需要服务器端的支持。如果你的服务器或托管平台支持这一功能,你可以通过启用VitePress的cleanUrls
配置选项来轻松实现。如果无法获得服务器支持,你将需要手动调整目录结构和文件命名来模拟出类似的效果。无论哪种方式,都应确保用户能够顺畅地访问你的网站并获得良好的体验。