Vue Press Github Pages .md 文件不起作用答案

【问题标题】：Vue Press Github Pages .md files not workingVue Press Github Pages .md 文件不起作用
【发布时间】：2019-05-21 09:03:18
【问题描述】：

错误报告

重现步骤

您好，我在将 Vue Press 文档部署为我的私有 Github 存储库的一部分时遇到了问题。我无法提供演示 URL，因为这可能会或可能不会与 Vue Press 或 Github 链接。

我使用vue create 命令生成了一个 Vue JS 项目，我在顶部添加了 Vue p11n 模块，因为这是我正在制作的插件。

我在 docs/ 文件夹下创建了我的 Vue Press 文档，并且在本地一切正常。我还没有触及配置文件，因为这里的一切都在工作。

我有几个文件：

README.md
安装.md
requirements.md
options.md

它们位于docs/ 下，然后是docs 目录中的.vuepress 文件夹。

文档网址：https://stsonline.github.io/vue-les-application/

我的 github 存储库是私有的，而且必须是私有的。

期望什么？

Github 页面上的文档应该按照本地副本加载，侧边栏应该可以正常工作，并且导航链接应该可以工作。

实际发生了什么？

当我将更改推送到 repo 时，我的 github 页面 url 似乎只加载 README.md 文件，而其他所有内容都不起作用，例如：无法访问这些页面。

我的 repo url 示例是：https://stsonline.github.io/vue-les-application/

单击“开始”链接时，它应该链接到安装页面，但侧边栏导航也不会丢失。

但是，在本地运行，一切都很好，包括可爱的绿色主题。

我错过了什么？

我必须保留一个父 docs/ 文件夹，因为这是用于 Github 页面的文件夹，我不能使用父 dist/ 目录。话虽如此，Vue Press 似乎是在 docs 目录中构建的。

我的docs/.vuepress/config.js 文件：

module.exports = {
  base: '/vue-les-application/',
  plugins: [
    require('./plugin.js')
  ],
  locales: {
    '/': {
      lang: 'en-US',
      title: 'VueLesApplication',
      description: 'VueLesApplication for Vue.js'
    }
  },
  themeConfig: {
    repo: '/vue-les-application',
    docsDir: 'docs',
    locales: {
      '/': {
        label: 'English',
        selectText: 'Languages',
        editLinkText: 'Edit this page on GitHub',
        nav: [{
          text: 'Release Notes',
          link: 'https://github.com//vue-les-application/releases'
        }],
        sidebar: [
          '/requirements.md',
          '/installation.md',
          '/options.md'
        ]
      }
    }
  }
}

我的docs/.vuepress/plugin.js 文件：

const { version } = require('../../package.json')

module.exports = (/*options, ctx*/) => ({
  async enhanceAppFiles () {
    const code = `export default ({ Vue }) => {
  Vue.mixin({
    computed: {
      $version () {
        return '${version}'
      } 
    }
  })
}`
    return [{
      name: 'vuepress-plugin-vue-cli-plugin-p11n',
      content: code
    }]
  }
})

其他相关信息

[x] 我的 VuePress 版本比 1.0.0-alpha.47 低且相同：
- VuePress 版本：1.0.0-alpha.48
- 操作系统：Mac 操作系统
- Node.js 版本：不适用
- 浏览器版本：Chrome 的最新版本
- 这是全局安装还是本地安装？不适用
- 您使用哪个包管理器进行安装？新PM
- 禁用所有插件时是否会出现此问题？是的
[ ]我的VuePress版本高于1.0.0-alpha.47，下面是我的VuePress项目中npx vuepress info的输出：

【问题讨论】：

标签： vue.js vuejs2 github-pages vuepress

【解决方案1】：

这是因为要使 gh-pages 工作，您必须从 gh-pages 分支或 dist/ 文件夹提供它。由于您正在构建 docs 文件夹，因此 GitHub 页面将永远不会提供该文件夹。您唯一的解决方案是确保 VuePress 构建到 dist 文件夹中。

GitHub 不允许对您可以从中提供页面的文件夹名称进行任何复杂的配置。另一种方法是使用子树，您实际上将子文件夹发布到gh-pages 分支：https://gist.github.com/cobyism/4730490

【讨论】：