Vue Press Github Pages .md файлы не работают - PullRequest
0 голосов
/ 21 мая 2019

Сообщение об ошибке

Действия по воспроизведению

Привет, у меня возникла проблема при развертывании моей документации Vue Press как части моего частного репозитория Github. Я не могу предоставить демонстрационный URL-адрес, поскольку он может или не может быть связан с Vue Press или Github.

Я сгенерировал проект Vue JS с помощью команды vue create, я добавил модуль Vue p11n сверху, так как это плагин, который я делаю.

Я создал свою документацию Vue Press в папке docs/, и локально все работает нормально. Я не трогал файлы конфигурации, так как все здесь работает.

У меня есть несколько файлов:

  • README.md
  • installation.md
  • requirements.md
  • options.md

Они расположены в docs/, а затем в папке docs есть папка .vuepress.

Документы URL: https://stsonline.github.io/vue-les-application/

Мой репозиторий github является частным и должен быть.

Что ожидается?

Документация на страницах Github должна загружаться в соответствии с локальной копией, должна работать боковая панель и работать навигационные ссылки.

Что на самом деле происходит?

Когда я отправляю свои изменения в репозиторий, URL-адрес моих страниц github, по-видимому, загружает только файл README.md, в то время как все остальное не работает, например: невозможно получить доступ к этим страницам.

Пример 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.j файл:

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 OS
    • Node.js версия: N / A
    • Версия браузера: последняя версия Chrome
    • Это глобальная или локальная установка? N / A * +1073 *
    • Какой менеджер пакетов вы использовали для установки? NPM
    • Эта проблема возникает, когда все плагины отключены? Да
  • [] Моя версия VuePress выше 1.0.0-alpha.47, ниже вывод npx vuepress info в моем проекте VuePress:

1 Ответ

0 голосов
/ 21 мая 2019

Это связано с тем, что для работы gh-страниц вам придется обслуживать его либо из ветви gh-pages, либо из папки dist/. Поскольку вы встраиваете в папку docs, это никогда не будет обслуживаться страницами GitHub. Ваше единственное решение - убедиться, что VuePress встроен в папку dist.

GitHub не допускает сложной настройки имени папки, из которой вы можете обслуживать страницы. Альтернативой является использование поддерева, где вы фактически публикуете подпапку в ветке gh-pages: https://gist.github.com/cobyism/4730490

...