我正在使用Jekyll在Github Pages上使用「Dinky」主題構建項目網頁, 。Tell Jekyll(在github頁面上)將README.md轉換爲README.html,而不是index.html
README.md
會自動轉換爲index.html
,這對快速入門非常有幫助。
不過,我想有一個單獨編寫的主頁index.md
,而是轉換到README.md
README.html
(因爲它與大多數*.md
文件一樣)。當我添加我的index.md
時,Jekyll將其轉換爲index.html
,但希望現在完全沒有轉換,因此README.md
可能會有index.html
作爲README.md
和index.md
的目標,後者將獲勝。
我該如何告訴Jekyll返回使用README.html
作爲其轉換目標README.md
?
優選地,我想,不需要在README.md
本身加入配置數據,讓我能繼續保持README.md
同步與在master
分支人類可讀版本的溶液。
重現它的注意事項:所有這些都是在通過Github Pages在線構建和當地的jekyll build
。我正在使用的唯一定製jekyll設置是該網站的Gemfile
中的gem 'github-pages', group: :jekyll_plugins
,以及該網站的_config.yml
中的theme: jekyll-theme-dinky
。
它似乎是特定於Github Pages主題,但不是Dinky主題:Dinky旁邊的其他主題展現出相同的行爲,但似乎並不是Jekyll站點。
編輯:感謝@wasthishelpful提供了非常有用的評論和部分答案。添加YAML frontmatter塊到README.md
設置permalink: README.html
做我正在尋找。不幸的是,我仍然無法通過修改_config.yml
找到實現相同效果的方法:例如,添加一個frontmatter默認那裏
defaults:
-
scope:
path: "README.md"
values:
permalink: "README.html"
似乎沒有任何效果。 (我之前和行theme: jekyll-theme-dinky
後都試過有和沒有周圍的文件名引號,和)
訪問Github上時Readme.md顯示在回購的根簡要概述,但他們都不在哲基爾網站 – marcanuy
生成的index.html @marcanuy:我知道Jekyll通常不會將'README.md'轉換爲'index.html',但是當使用帶有主題的Github Pages時,我向你保證。我將編輯我的答案以澄清我嘗試過的內容,但是簡要地說,這發生在本地構建中,並且通過Github Pages提供時,除了用於Github Pages主題的設置之外,我沒有任何本地自定義設置。 – PLL
我無法複製它,從來沒有看到README.md被轉換爲'index.html'。 – marcanuy