qhxin

发布 GitHub Pages,现在就像数 1, 2, 3 那样简单 · GitHub

qhxin · 2016-12-09翻译 · 847阅读 原文链接

在 GitHub Pages 发布网站或者软件文档现在只需要更少的步骤——精确来说是三步:

  1. 创建一个 GitHub 仓库(或者选择一个已经创建好的仓库);

  2. 像你提交其它任何文件一样,通过 GitHub 的网页提交一个 Markdown 文件;

  3. 在你的仓库设置那里激活 GitHub Pages 。

就像这样就行了——你现在已经拥有了一个网站。如果你已经对 GitHub Pages 熟悉了,你或许会对知道一些幕后的东西感兴趣,我们现在正在做一些事情去简化这个发布流程,并且让它更加如你所期待的那样在 GitHub 的其它地方创作 Markdown 内容。

  1. 所有的 Markdown 文件现在都被 GitHub Pages 渲染,把你从需要给每个文件添加 YAML 前置描述(在文件顶部由---符号分割的元数据)中解脱出来。

  2. 如果你没有一个名为index.md(或者index.html)的文件,我们会使用你的 README 文件作为站点的首页,就和你在 GitHub 浏览一个仓库时看到的一样。

  3. 如果你没有在你的站点配置文件里指定主题(或者根本就没有站点配置文件),我们将设置一个最小化的、和其它在 GitHub 上的 Markdown 文件的外观及体验相匹配的默认主题。

  4. 如果一个给定的文件没有明确的指明使用什么布局,我们将根据它的上下文指定一个。举个例子,页面会自动的变成page布局,而如果page布局不存在,它会变成default布局。

  5. 如果你的页面没有一个明确的标题,并且这个文件是由 H1、H2或者 H3 标签开始的,我们会使用这个标签内容作为页面的标题,显示在浏览器的标签上。

这些改进应该能让你更快更简单的通过几次点击发布你的第一个(或者第一百个)网站,或者通过简单地添加 Markdown 文件到/docs目录 ,在仓库内给你的软件项目编写文档。当然,你依然可以通过额外的自定义设置(比如使用你自己的布局和样式来覆盖默认主题)来继续控制外观和体验。

虽然这些改动应该不会影响大多数现有站点的建设,但对于早期的 Jekyll 用户来说有两个潜在的陷阱:

  1. 如果你的站点遍历了所有页面(例如,for page in site.pages),你可能会发现现在有额外的页面(比如第三方依赖库的 README 页面)在这个列表里。你可以使用配置文件里的exclude配置显式地排除这些文件。

  2. 如果你没有指定一个页面的布局和标题,并且希望它一直保持这样(例如,假如你需要提供无样式的内容),你需要明确地将这些配置的值设为null

如果出于任何原因你不想使用这些特性,你可以通过添加一个.nojekyll文件到你的站点根目录来禁用它们。

所以, GitHub Pages 生成过程是可以尽可能透明和可定制的,所有上面提到的特性都是以 Jekyll 的开源插件的形式实现的,也就是 Jekyll Optional Front Matter , Jekyll README IndexJekyll Default Layout ,以及 Jekyll Titles from Headings 这些插件。

再者,这些变化不应该影响大多数现有站点的建设(虽然你可以安全的开始使用这些特性),但是如果你有任何问题,请联系我们

三步发布快乐!

相关文章