- 介绍
- 起步
- 配置
- 静态资源处理
- Markdown 扩展
- 在 Markdown 中使用 Vue
- 自定义主题
- 国际化支持(internationalization)
- 部署
- 基本配置(basic config)
- 主题化(theming)
- Markdown
- 建立管道(build pipeline)
- 浏览器兼容性(browser compatibility)
- 主页(homepage)
- 导航栏(navbar)
- 侧边栏(sidebar)
- 搜索框(search box)
- 最近更新
- Service Worker
- 上一页 / 下一页链接(prev / next links)
- Git 仓库和编辑链接
- 简单的 CSS 覆盖
- 自定义页面的 class
- 特定页面的自定义布局(custom layout for specific pages)
- 弹出(ejecting)
基本配置(basic config)
base
- Type:
string - Default:
/
网站用来部署的基准 URL。如果你打算在子路径下部署你的站点，例如 GitHub 页面，则需要设置此项。如果你打算将你的网站部署到https://foo.github.io/bar/，则应将 base 设置为 "/bar/"。它应该始终以斜杠开始和结束。
在其他选项中，base 会自动添加到以 / 开头的所有 URL 中，因此你只需指定一次即可。
另请参考：
- 基准 URL
- 部署教程 > Github 页面
title
- Type:
string - Default:
undefined
网站的标题。这将是所有页面标题的前缀，并显示在默认主题的导航栏中。
description
- Type:
string - Default:
undefined
网站描述。这将在页面 HTML 中表现为一个 <meta> 标签。
head
- Type:
Array - Default:
[]
被注入页面 HTML <head> 额外的标签。每个标签可以用 [tagName, { attrName: attrValue }, innerHTML?] 的形式指定。例如，要添加自定义图标：
module.exports = {
head: [
['link', { rel: 'icon', href: '/logo.png' }]
]
}
host
- Type:
string - Default:
'0.0.0.0'
指定用于 dev 服务器的主机。
port
- Type:
number - Default:
8080
指定用于 dev 服务器的端口。
dest
- Type:
string - Default:
.vuepress/dist
指定 vuepress build 的输出目录。
ga
- Type:
string - Default:
undefined
提供 Google AnalyticsID 来开启集成功能。
提示
请留意 GDPR (2018年欧盟数据保护规则改革) , 在合适或者需要的情况下，考虑将 Google Analytics 设置为匿名化的 IP 。
serviceWorker
- Type:
boolean - Default:
false
如果设置为 true，VuePress 将自动生成并注册一个 service worker ，这个 worker 将内容缓存以供离线使用（仅在生产环境中启用）。
如果开发了一个自定义主题，Layout.vue 组件还将触发以下事件：
sw-readysw-cachedsw-updatedsw-offlinesw-error
PWA 注意事项
serviceWorker 选项只能处理 service worker。要使你的站点完全符合 PWA，你需要在.vuepress/public 中提供 Web App 清单和图标。有关更多详细信息，请参阅 MDN 关于 Web 应用程序清单的文档 。
此外，只有在你能够使用 SSL 部署你的站点时才能启用此功能，因为 service worker 只能在 HTTPs URLs 下注册。
locales
- Type:
{ [path: string]: Object } - Default:
undefined
指定用于 i18n 支持，要获取更多细节，请参考国际化指南。
shouldPrefetch
- 类型:
Function - 默认值:
() => true
一个函数，用来控制对于哪些文件，是需要生成 <link rel="prefetch"> 资源提示的。请参考 shouldPrefetch 。
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论