自定义主题

    VuePress 使用单文件组件来构建自定义主题。想要开发一个自定义主题,首先在你的文档根目录新建一个 文件夹,然后再创建一个 Layout.vue 文件:

    从这里开始,就和开发一个平时的 Vue 应用一样了,如何组织你的主题完全取决于你。

    Layout 组件将会对每一个文档目录下的 .md 执行一次,同时,整个网站以及特定页面的元数据将分别暴露为 this.$sitethis.$page 属性,它们将会被注入到每一个当前应用的组件中。

    这是你现在看到的这个网站的 $site 的值:

    1. {
    2. "title": "VuePress",
    3. "base": "/",
    4. "pages": [
    5. {
    6. "lastUpdated": 1524027677000,
    7. "path": "/",
    8. "title": "VuePress",
    9. "frontmatter": {}
    10. },
    11. ]
    12. }

    下面的这个对象是你正在看的这个页面的 $page 的值:

    如果用户在 .vuepress/config.js 配置了 themeConfig,你将可以通过 $site.themeConfig 访问到它。如此一来,你可以通过它来对用户开放一些自定义主题的配置 —— 比如指定目录或者页面的顺序,你也可以结合 $site.pages 来动态地构建导航链接。

    最后,别忘了,作为 Vue Router API 的一部分,this.$routethis.$router 同样可以使用。

    ::: tip 提示
    lastUpdated 是这个文件最后一次 git 提交的 UNIX 时间戳,更多细节请参考:最后更新时间
    :::

    内容摘抄

    当前的 .md 文件渲染的内容,可以作为一个独特的全局组件 <Content/> 来使用,你可能想要它显示在页面中的某个地方。一个最简单的主题,可以是一个唯一的 Layout.vue 组件,并包含以下内容:

    1. <template>
    2. <div class="theme-container">
    3. <Content/>
    4. </div>
    5. </template>

    应用配置

    自定义主题也可以通过主题根目录下的 enhanceApp.js 文件来对 VuePress 应用进行拓展配置。这个文件应当 export default 一个钩子函数,并接受一个包含了一些应用级别属性的对象作为参数。你可以使用这个钩子来安装一些附加的 Vue 插件、注册全局组件,或者增加额外的路由钩子等:

    主题可以以 Vue 单文件组件的格式,并以 vuepress-theme-xxx 的名称发布到 npm 上。

    如果想使用一个来自 npm 的主题,你需要在 .vuepress/config.js 补充 theme 选项:

    1. module.exports = {
    2. }

    修改默认主题

    你可以使用 这个命令来将默认主题的源码复制到 .vuepress/theme 文件夹下,从而可以对默认主题进行任意的修改。需要注意的是一旦 eject,即使升级 VuePress 你也无法再获得 VuePress 对默认主题的更新。