GitHub 页面和相关路径

我已经为我在 GitHub 工作的一个项目创建了一个 gh-pages分支。

我使用 Sublime 文本在本地创建网站,我的问题是,当这个文本被推送到 GitHub 时,所有到 javascrips、图像和 css 文件的链接都是无效的。

比如,我脑袋里就有这个。

<link href="assets/css/common.css" rel="stylesheet">

这在本地非常有效,但是在 GitHub 上不起作用,因为链接没有使用存储库名称作为 URL 的一部分进行解析。

它要求:

http://[user].github.io/assets/css/common.css

而它本应该要求的是:

http://[user].github.io/[repo]/assets/css/common.css.

当然,我可以将回购名称作为 URL 的一部分,但这会阻止我的站点在开发期间在本地工作。

知道怎么处理吗?

50396 次浏览

Which browser are you using? Are you sure that this happens? Because it shouldn't. If you include a relative URL in a link, it will get resolved relative to the URL of the document that contains the link. In other words, when you include

<link href="assets/css/common.css" rel="stylesheet">

in an HTML document at http://www.foo.com/bar/doc.html, the link to assets/css/common.css will get resolved by appending it to the prefix of the URL of the HTML document without the last part of the path (without doc.html), i.e. the link will resolve to http://www.foo.com/bar/assets/css/common.css, not to http://www.foo.com/assets/css/common.css as you claim.

For example, view the source of the Twitter Bootstrap webpage: http://twitter.github.io/bootstrap/. Notice the style links at the top, specified as <link href="assets/css/bootstrap.css" rel="stylesheet">. That link correctly resolves to http://twitter.github.io/bootstrap/assets/css/bootstrap.css, i.e. it does include the repo name.

It seems that Github Pages is not very responsive. Though it makes new files available immediately, modified files would not appear immediately due to caching or something.

After waiting 15 minutes or so, everything is fine.

You'll need to use Jekyll.

Copying verbatim from the relevant documentation:

Sometimes it’s nice to preview your Jekyll site before you push your gh-pages branch to GitHub. However, the subdirectory-like URL structure GitHub uses for Project Pages complicates the proper resolution of URLs. Here is an approach to utilizing the GitHub Project Page URL structure (username.github.io/project-name/) whilst maintaining the ability to preview your Jekyll site locally.

  1. In _config.yml, set the baseurl option to /project-name – note the leading slash and the absence of a trailing slash.

  2. When referencing JS or CSS files, do it like this: \{\{ site.baseurl}}/path/to/css.css – note the slash immediately following the variable (just before “path”).

  3. When doing permalinks or internal links, do it like this: \{\{ site.baseurl }}\{\{ post.url }} – note that there is no slash between the two variables.

  4. Finally, if you’d like to preview your site before committing/deploying using jekyll serve, be sure to pass an empty string to the --baseurl option, so that you can view everything at localhost:4000 normally (without /project-name at the beginning): jekyll serve --baseurl ''

This way you can preview your site locally from the site root on localhost, but when GitHub generates your pages from the gh-pages branch all the URLs will start with /project-name and resolve properly.

(Apparently someone figured this out only a few months ago.)

This should not be an issue anymore in Dec. 2016, 3 and an half years later.
See "Relative links for GitHub pages", published by Ben Balter:

You've been able to use relative links when authoring Markdown on GitHub.com for a while.

(that is from January 2013)

Now, those links will continue to work when published via GitHub Pages.

If you have a Markdown file in your repository at docs/page.md, and you want to link from that file to docs/another-page.md, you can do so with the following markup:

[a relative link](another-page.md)

When you view the source file on GitHub.com, the relative link will continue to work, as it has before, but now, when you publish that file using GitHub Pages, the link will be silently translated to docs/another-page.html to match the target page's published URL.

Under the hood, we're using the open source Jekyll Relative Links plugin, which is activated by default for all builds.

Relative links on GitHub Pages also take into account custom permalinks (e.g., permalink: /docs/page/) in a file's YAML front matter, as well as prepend project pages' base URL as appropriate, ensuring links continue to work in any context.

And don't forget that since August 2016, you can publish your pages right from the master branch (not always the gh-pages branch)

And since Dec. 2016, you don't even need Jekyll or index.md. Simple markdown files are enough.

Another option is to create a new repo specifically for the github.io webpages. If you name the repo as [user].github.io on github then it will be published at https://[user].github.io and you can avoid having the repo name in the URL path completely. Obviously the downside is that you can only have 1 repo like this per github user, so it may not suit your needs, I'm not sure.

You could just put this

<base href="/[repo]/">

inside of the <head> tag, and it solves the problem.

You could also improve this solution by setting:

<base href="\{\{site.baseurl}}" />

and then set site.baseurl to empty string for the local testing.

The best option is now the relative_url filter:

<link href="\{\{ '/assets/css/common.css' | relative_url }}" rel="stylesheet">