为github PROJECT页面配置Jekyll

我在这里结束了我的智慧。 我一直在试图查看我能找到的所有其他示例github项目页面,甚至是博客,但没有一个表现出我遇到的问题。 首先,我正在尝试为我的仓库创建一个项目页面。 我按照通常的教程,在我的项目仓库和推送中创建了一个gh-pages分支。

我设法做了这些并模板化我的文件。 我甚至设法使用HAML和SASS(它们仍然转换为html / css,这就是我推送到repo所以没有问题)。 我只是认为我正在配置我的jekyll错误。 首先,我没有看到在config.yml上使用baseurl或url的其他人页面中的任何配置。

我的问题是在我的post中循环:

{% for post in site.posts %} {{ post.title }} {% endfor %} 

它始终生成href为href="/post-title"

我的_config.yml btw只有这个:

 permalink: /exercises/:title 

单击链接时出现此问题,它始终指向http://corroded.github.com/exercises/title-其实应该是http://corroded.github.com/projectname/exercises/title-这里

我实际上尝试通过以下方式对路径进行硬编码:

这是有效的。 它转到post但是它显示为纯文本而不是生成的html。 我知道我在这里错过了一些非常简单的东西,但我似乎无法找到它,整个周末我一直在努力解决这个问题。

哦,我忘了添加:在我的localhost中执行此操作,我可以访问以下所有内容:

http://localhost:4000/并点击链接将我带到http://localhost:4000/exercises/title-here和IT WORKS。 所以我很好地猜测它与配置有关。

如果在永久链接的前面有斜杠,则表示所有URL都应该相对于站点根目录。 这就是为什么它会转到http://corroded.github.com/exercises/title-here而不是http://corroded.github.com/projectname/exercises/title-here 。 没有第一个斜线尝试它:

 permalink: exercises/:title 

对于使用HTML创建的任何URL,情况都是如此。 如果你有:

  

它将始终到域的根目录(例如http://corroded.github.comhttps://stackoverflow.com/about )。 如果你的项目被称为’projectname’,你可以像使用HTML一样

  

直接链接到页面(例如http://corroded.github.com/projectnamehttps://stackoverflow.com/about )。

当然,您也可以使用相对URL (即没有前导斜杠的URL)。 您只需要知道您在目录树中的位置。

编辑:此答案已添加到http://jekyllrb.com/docs/github-pages/的Jekyll文档中。


如果你正在寻找一个带有GitHub页面标准URL的解决方案( username.github.io/project-name/ ),我终于找到了诀窍。 这是做什么的:

_config.yml ,将baseurl选项设置为/project-name – 注意前导斜杠和没有尾部斜杠。

现在,您需要通过以下两种方式更改模板和post中的链接方式:

在引用JS或CSS文件时,请执行以下操作: {{ site.baseurl }}/path/to/css.css – 请注意紧跟在变量之后的斜杠(在“path”之前)。

在执行永久链接或内部链接时,请执行以下操作: {{ site.baseurl }}{{ post.url }} – 请注意,这两个变量之间没有斜杠。

最后,如果您想在使用jekyll serve提交/部署之前预览您的站点,请确保将空字符串传递给--baseurl选项,以便您可以正常查看localhost:4000所有内容(不使用/project-name进入那里jekyll serve --baseurl ''一切): jekyll serve --baseurl ''

这样,您可以从localhost上的站点根目录本地预览您的站点,但是当GitHub从gh-pages分支生成您的页面时,所有URL都将以/project-name开头并正确解析。

问题#332上关于这个问题的更多讨论。