VitePress 笔记

VitePress 笔记

💡 原文约800字/词,阅读约需3分钟。
📝

内容提要

本文介绍了VitePress的配置与功能,包括图片处理、添加logo、定制CSS、设置基础URL、启用搜索、添加favicon、支持Mermaid图表、社交图标和自定义页脚等,并提供了代码示例和官方链接。

🎯

关键要点

  • VitePress的配置与功能介绍
  • 图片和其他资源应使用相对路径引用
  • Logo可以在首页右侧和所有页面左上角添加
  • 可以通过自定义CSS修改网站的外观
  • 设置基础URL以适应非根目录的访问
  • 启用本地搜索功能,支持Algolia集成
  • 添加favicon的简单方法是将其放在./docs/public/目录中
  • 支持Mermaid图表的插件安装与配置
  • 可以自定义社交图标并添加链接
  • 可以在首页添加自定义页脚
  • 文档页面可以显示最后修改日期和GitHub编辑链接

延伸问答

如何在VitePress中添加logo?

可以在首页右侧和所有页面左上角添加logo,通过修改配置文件.vitepress/config.js来设置logo的路径。

VitePress支持哪些社交图标?

VitePress支持的社交图标包括Discord、Facebook、GitHub、Instagram、LinkedIn、Slack、Twitter和YouTube。

如何启用VitePress的本地搜索功能?

在配置文件.vitepress/config.js中添加搜索配置,设置provider为'local'即可启用本地搜索功能。

如何在VitePress中添加自定义CSS?

可以通过在.vitepress/theme/index.js中导入自定义CSS文件来修改网站的外观。

VitePress如何处理图片和其他资源?

图片和其他资源应使用相对路径引用,VitePress会在构建时将它们放在正确的位置。

如何在VitePress中添加favicon?

将favicon文件放在./docs/public/目录中,并在.vitepress/config.js中进行相应配置即可。

➡️

继续阅读