CONTRIBUTING.md не отображается как веб-страница на страницах github

Я в процессе перемещения моего contributing.md файл из корневого каталога проекта в каталог docs/, чтобы он мог быть с остальной документацией. Другие файлы markdown в docs правильно отображаются при просмотре на страницах github. Например, страница



Https://jtablesaw.github.io/tablesaw/userguide/toc
визуализация страницы toc.md как и ожидалось.



Однако,



Https://jtablesaw.github.io/tablesaw/contributing



Возвращает 404, в то время как просто добавление расширения .md



Https://jtablesaw.github.io/tablesaw/contributing.md



Возвращает страницу в качестве источника markdown



Проект github - это https://github.com/jtablesaw/tablesaw .
и еще ... contributing.md файл находится в папке docs/.

882   2  

2 ответов:

Ответ Захарии верен, но есть способ изменить конфигурацию Джекила, чтобы включить конкретную страницу.

Вот пример: https://masterex.github.io/test-docs/contributing

Вы должны изменить _config.yml следующим образом: 

theme: jekyll-theme-minimal
include: contributing.md

Здесь находится соответствующая страница справки github.

2  
2017-08-27 01:21:36

После раздвоения вашего РЕПО, немного повозившись с ним и стукнувшись головой о стену, потому что я не понимал, почему он не работает, я кое-что понял:

GitHub Pages не поддерживает создание страниц Jekyll из файлов с именами, которые Github распознает для других целей. эти имена файлов включают (в дополнение к их нижнему регистру версии):

С другой стороны, несмотря на то, что README.md также является файлом ключевых слов Github, похоже, что GitHub Pages поддерживает использование файлов с именем README.md, поскольку он намеренно интерпретирует их так же, как файл index.md или index.html. Смотрите эту ссылку из блога Github для получения дополнительной информации.

К ответьте на ваш конкретный вопрос о том, как вы могли бы получить файл, чтобы показать на пути /tablesaw/contributing, вы могли бы переименовать его и переместить его в путь /docs/contributing/index.md или /docs/contributing/README.md.

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

Редактировать: @Master_ex правильно отмечает, что вы можете использовать include опция конфигурации в файле _config.yml для включения файлов, которые обычно исключаются Github: 

theme:   jekyll-theme-minimal
include: contributing.md

В соответствии с исходным примером это позволит страницам Github успешно построить страницу по пути /docs/contributing.

2  
2017-08-27 01:40:23

Comments

    Ничего не найдено.
Click here to cancel reply.