2017-08-26 65 views
3

我正在將我的contributions.md文件從項目根目錄移至docs /目錄,因此可以與其餘文檔一起移動。在github頁面中查看時,文檔中的其他降價文件可以正確呈現。例如,頁面CONTRIBUTING.md不會呈現爲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

返回頁面降價源

GitHub的項目是https://github.com/jtablesaw/tablesaw 。 和contributions.md文件位於文檔/文件夾中。

+0

你可以添加直接鏈接到你的Github回購? –

+0

另外,你可以指定是否使用'/ docs'文件夾或'gh-pages'分支嗎? –

+0

['https://jtablesaw.github.io/tablesaw/contributing.md'](https://jtablesaw.github.io/tablesaw/contributing.md)可以訪問。 –

回答

2

Zachary的回答是正確的,但有一種方法可以修改jekyll的配置以包含特定的頁面。

下面是一個例子:https://masterex.github.io/test-docs/contributing

您必須修改_config.yml如下:

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

Here是GitHub的相關幫助頁面。

2

分叉your repo,玩了一個位,和敲我的頭靠在牆上,因爲我不明白爲什麼它不工作後,我意識到的東西:

Github的頁面不支持從具有Github可識別用於其他目的的名稱的文件構建Jekyll頁面。這些文件的名稱包括(除了自己的小寫版本):

在另一方面,儘管README.md是al所以一個Github關鍵字文件,它看起來像Github Pages支持使用名稱爲README.md的文件,因爲它故意將它們解釋爲與index.mdindex.html文件相同的方式。有關更多信息,請參閱this link from the Github blog


要回答你的你如何能得到該文件在/tablesaw/contributing路徑顯示特定的問題,你可以將其重命名,並將其移動到/docs/contributing/index.md/docs/contributing/README.md路徑。

不幸的是,̶至少在現在,̶̶t̶h̶e̶r̶e̶'̶s̶目前還沒有辦法,使之與相同的文件名且具有GitHub的網頁構建一個頁面它。̶


編輯:@Master_ex筆記正確,你可以使用include configuration option_config.yml文件,包括那些通常由Github上被排除的文件:

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

在參考原來的例子,這將允許Github Pages在/docs/contributing路徑上成功建立頁面。