simplest jekyll

最简单的Jekyll

GH页面上的最小基于Jekyll的网站，简化为具有主题的内容的一页

预览

关于

这是一个模板和现场演示项目。它显示了您在GH页面上获得jekyll网站的设置很少。

• index.md
  • 对于主页 - 在这种情况下唯一的页面。
  • 如果您遗漏了此页面，则将README.md用作您的主页。
• _config.yml
  • 设置主题 - 处理布局和样式。
  • 启用Jekyll SiteMap插件 - 在Gemfile中启用它是不够的。请注意，其他插件将为您启用，例如可选的FrontMatter。
  • 其他标准值（例如baseurl ， title和description已排除在配置中。在GH页面上构建时，将为您推断出GH Pages Gem。
• gemfile
  • GH页面实际上不是使用它，但是它允许您使用Bundler在本地安装Jekyll主题。
  • 如果要匹配GH页面上的所有宝石，请使用单个github-pages （可以安装很重）。
  • 如果您不需要在本地运行您的网站，请删除此文件。

如果您想要一个更加完善的示例，其中包含帖子，宝石，布局等的多页网站。它也可以用作模板和演示站点。

如何使用这个项目

设置

1. 单击使用此模板在您自己的帐户中创建一个新存储库。您可以将名称作为simplest-jekyll留下。
2. 在您的存储库设置中启用GitHub页面。选择从master分支和/路径选项中服务。
3. 检查您的回购环境选项卡以查看部署何时完成。
4. 单击视图部署以查看实时站点。例如https://michaelcurrin.github.io/simplest-jekyll/

请注意， /simplest-jekyll/index.html可以立即使用，但需要几分钟才能制作/simplest-jekyll/可用。

定制

• 使用您自己的详细信息更新README.md 。这实际上不是在部署的站点中使用的，而是在本地和GitHub上可见的。
• 主题
  • 如果您想要另一个主题，请在_config.yml中编辑主题。
  • 您还可以使用回购设置的GitHub页面部分进行视觉预览。
  • 注意仅涵盖了GitHub页面支持的主题（大约10），但是如果您使用配置中的远程_theme字段，则可以参考更多主题。
  • 要在本地安装和运行，您需要确保您的Gemfile涵盖配置中使用的主题。
• 与大多数jekyll站点一样，index.md用作首页。
  • 它在顶部具有前面物质，因此将使用任何液体。
  • 用自己的内容或Markdown编辑您的index.md文件。
  • 如果您只需要普通的HTML，则可以将其重命名为index.html 。
  • 您可以删除顶部的前物质，以删除液体格式和任何主题。
• 如果愿意，请在根部添加更多页面，然后将任何常见的HTML（例如标头，头部或Navbar）中断为_includes文件夹或_layouts文件夹（该项目的范围都不涵盖，但对于Jekyll Projects来说是常见的）。
• 有关更多信息，请参见Jekyll网站上的文档和教程。
• 可选地在本地运行Jekyll：
  • 安装Ruby和Bundler。
  • 安装项目宝石 - 杰基尔和主题宝石。
  • 运行Jekyll Dev服务器。
  • 有关完整说明，请参见Jekyll博客演示文档。您还需要添加一个Makefile才能匹配这些命令。

相关项目

• - Jekyll CLI生成的默认博客。使用主题，内容，样式设置，宝石和makefile。
• - 使用jekyll 4，主题，github动作和github页面。
• - 最小的jekyll网站具有主题，但没有gemfile。

执照

在MIT下发布@MichaelCurrin。