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。