{"id":13558425,"url":"https://github.com/chrisbobbe/jekyll-theme-prologue","last_synced_at":"2025-05-15T01:09:13.009Z","repository":{"id":28177578,"uuid":"116535387","full_name":"chrisbobbe/jekyll-theme-prologue","owner":"chrisbobbe","description":"A Jekyll version of the \"Prologue\" theme by HTML5 UP","archived":false,"fork":false,"pushed_at":"2024-02-03T14:30:19.000Z","size":1145,"stargazers_count":443,"open_issues_count":34,"forks_count":932,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-13T23:53:44.960Z","etag":null,"topics":["blog","jekyll","jekyll-theme","jekyll-themes","portfolio","prologue"],"latest_commit_sha":null,"homepage":"https://chrisbobbe.github.io/jekyll-theme-prologue/","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chrisbobbe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-07T03:51:49.000Z","updated_at":"2025-03-27T16:57:09.000Z","dependencies_parsed_at":"2023-09-27T03:24:50.923Z","dependency_job_id":"d18a1849-1678-4894-be6e-b1d63de30138","html_url":"https://github.com/chrisbobbe/jekyll-theme-prologue","commit_stats":{"total_commits":103,"total_committers":3,"mean_commits":"34.333333333333336","dds":0.09708737864077666,"last_synced_commit":"53cd4c877fb8b47f89fbe688837942011549b733"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbobbe%2Fjekyll-theme-prologue","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbobbe%2Fjekyll-theme-prologue/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbobbe%2Fjekyll-theme-prologue/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbobbe%2Fjekyll-theme-prologue/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrisbobbe","download_url":"https://codeload.github.com/chrisbobbe/jekyll-theme-prologue/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254254042,"owners_count":22039792,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blog","jekyll","jekyll-theme","jekyll-themes","portfolio","prologue"],"created_at":"2024-08-01T12:04:56.881Z","updated_at":"2025-05-15T01:09:07.994Z","avatar_url":"https://github.com/chrisbobbe.png","language":"SCSS","funding_links":[],"categories":["SCSS","jekyll-theme"],"sub_categories":[],"readme":"# ⚠️ Unmaintained ⚠️\r\n\r\n# Prologue - Jekyll Theme\r\n\r\n[![Gem Version](https://badge.fury.io/rb/jekyll-theme-prologue.svg)](https://badge.fury.io/rb/jekyll-theme-prologue)\r\n\r\n![Prologue Theme](assets/images/screenshot.png \"Prologue Theme Screenshot\")\r\n\r\nThis is Prologue, a simple, single page responsive site template from [HTML5 UP](https://html5up.net/prologue), now available as a blog-aware Jekyll theme from [Chris Bobbe](https://chrisbobbe.github.io). It features a clean, minimalistic design and a sticky sidebar with navigation-linked scrolling.\r\n\r\n**Demo**: https://chrisbobbe.github.io/jekyll-theme-prologue/\r\n\r\n# Added Features\r\n\r\n* **Blogging and multi-page features you expect from Jekyll**\r\n* Compatible with GitHub Pages\r\n* **[Formspree.io](https://formspree.io/) contact form integration** - just add your email to the `_config.yml` and it works!\r\n* Build your homepage with **custom scrolly sections** in the _sections folder\r\n * Set a **cover photo** for any section (not just the first), with alt text for screen readers and SEO\r\n* Add your **social profiles** easily in `_config.yml`.\r\n* Automatic search engine optimization (SEO) **meta tags** based on info you provide in `_config.yml` and frontmatter\r\n* **Google Analytics** built-in; just put your [Tracking ID](https://support.google.com/analytics/answer/1008080?hl=en) in `_config.yml` as `google_analytics`\r\n* Custom **404 page** (called 404.html; to activate, move it to your project directory).\r\n\r\n# Installation\r\n\r\nThere are two ways to get started (choose one):\r\n\r\n1. **Install the [jekyll-theme-prologue gem](https://rubygems.org/gems/jekyll-theme-prologue).** Instructions are in the [Jekyll docs](https://jekyllrb.com/docs/themes/#installing-a-theme). After running `bundle install`, you can find the theme files by running `open $(bundle show jekyll-theme-prologue)`.  A sample working `_config.yml` file ships with the gem; if you want to activate it, move it to your project's root directory. It will do nothing until you move it there, replacing the default `_config.yml` file.\r\n2. **Fork or clone the [GitHub repository](https://github.com/chrisbobbe/jekyll-theme-prologue).** If you want to use [GitHub Pages](https://pages.github.com/), create a branch named `gh-pages`, and replace `theme: jekyll-theme-prologue` with `remote_theme: chrisbobbe/jekyll-theme-prologue` in the provided `_config.yml` ([GitHub Pages now supports open-source themes on GitHub](https://github.com/blog/2464-use-any-theme-with-github-pages)).\r\n\r\nNext, make sure that `url` and `base_url` are set for your own website in `_config.yml`. For local testing, make them both blank. Add a photo avatar to your project, then set `avatar: path/to/your/avatar.jpg` in _config.yml; for example, `avatar: assets/images/avatar.jpg` (48x48 pixels works best). Poke around the sample `_config.yml` file to see how you can add your social profiles.\r\n\r\n# Build your homepage\r\n\r\n1. **Your `_config.yml` file must include the following line or your homepage won't work**: `collections: [sections]`. This tells Jekyll to look in the _sections folder (which you will create) for your content and render it all on one page.\r\n\r\n2. **Create a `_sections` folder** in your project's root directory and start adding content to your homepage. Set a cover photo in any of the sections by adding `cover-photo: path/to/photo.jpg` and `cover-photo-alt: your alt text here` to the section's frontmatter. Sample content is provided in the [GitHub repository](https://github.com/chrisbobbe/jekyll-theme-prologue/tree/master/_sections).\r\n\r\nAll new sections should be added as html or Markdown documents in the `_sections` folder. The following section variables can be set with [frontmatter](https://jekyllrb.com/docs/frontmatter/):\r\n- `title` (required)\r\n- `order` (required; orders the sequence of sections on the page. Example: `1`)\r\n- `cover-photo` (optional; sets a background image for the section. Example: `assets/images/banner.jpg`)\r\n- `cover-photo-alt` (required if using a cover photo. Describes the photo for screen readers and SEO; e.g. \"Dome of Light art installation, Kaohsiung, Taiwan\")\r\n- `icon` (optional; see [Font Awesome](https://fontawesome.com/icons) for icon codes. Example: `fa-github`)\r\n- `icon-style` (optional; \"solid\" is default, \"regular\" for outline style icons, or \"brands\" for logos)\r\n- `auto-header` (optional; \"use-title\" is default, \"none\" for no header, or custom header text)\r\n- `hide` (optional; if `true`, the section won't appear)\r\n\r\n# Start blogging!\r\n\r\nJekyll has great resources to get you started writing blog posts. Check out [this Jekyll Docs page](https://jekyllrb.com/docs/posts/) first. When you've written a post or two, copy the following into a new file in your project directory called `blog.html`, and you'll see a link to your blog from the homepage:\r\n\r\n```\r\n---\r\nlayout: blog\r\ntitle: My Blog\r\n---\r\n```\r\n\r\n-- and that's it!\r\n\r\n# Add a page\r\n\r\nTo add a page, just make a new .html or .md file in your project directory. There's an example called `reading-list` [provided](https://github.com/chrisbobbe/jekyll-theme-prologue/blob/master/reading-list.md) with the GitHub repository. Add this frontmatter:\r\n\r\n```\r\n---\r\ntitle: My New Page\r\nlayout: page\r\n---\r\n```\r\n\r\nYou can also set these page variables in the frontmatter, if you want:\r\n- `subtitle`\r\n- `order` (orders links in the nav menu, e.g. `1`)\r\n- `icon` (optional; see [Font Awesome](https://fontawesome.com/icons) for icon codes. Example: `fa-github`)\r\n- `icon-style` (optional; \"solid\" is default, \"regular\" for outline style icons, or \"brands\" for logos)\r\n- `hide` (optional; if `true`, a link won't appear in the nav menu. All this does is remove the nav link; your page will still be served to anyone who has the URL.)\r\n\r\n**This same set of frontmatter variables (including `title`) can also be set in `index.md` and `blog.html`.** You may want to give them titles, or hide the homepage link with `hide: true` if the homepage is the only page.\r\n\r\nFor advanced SEO, this theme also lets you add `permalink` (see [Jekyll Docs](https://jekyllrb.com/docs/permalinks/#where-to-configure-permalinks)), `robots` (string, e.g. \"noindex, nofollow\"), and `canonical` (boolean; true is default) to any page or post.\r\n\r\n# Contributing\r\n\r\nPlease feel free to submit issues and feature requests!\r\n\r\n# Credits\r\n\r\nThanks to @andrewbanchich for his many Jekyll adaptations of HTML5 UP's elegant themes, which helped and inspired me, and of course many thanks to HTML5 UP.\r\n\r\nOriginal README from HTML5 UP:\r\n\r\n```\r\nPrologue by HTML5 UP\r\nhtml5up.net | @ajlkn\r\nFree for personal and commercial use under the CCA 3.0 license (html5up.net/license)\r\n\r\n\r\nThis is Prologue, a simple, single page responsive site template. It features a\r\nclean, minimalistic design and a sticky sidebar with navigation-linked scrolling.\r\n\r\nDemo content images* are courtesy of the ridiculously talented Felicia Simion. Check out\r\nmore of her amazing work over at deviantART:\r\n\r\nhttp://ineedchemicalx.deviantart.com/\r\n\r\n(* = Not included! Only meant for use with my own on-site demo, so please do NOT download\r\nand/or use any of Felicia's work without her explicit permission!)\r\n\r\nDemo banner images* courtesy of Unsplash, a radtastic collection of CC0 (public domain)\r\nimages you can use for pretty much whatever.\r\n\r\n(* = Not included)\r\n\r\nAJ\r\naj@lkn.io | @ajlkn\r\n\r\nPS: Not sure how to get that contact form working? Give formspree.io a try (it's awesome).\r\n\r\n\r\nCredits:\r\n\r\n\tDemo Images:\r\n\t\tFelicia Simion (ineedchemicalx.deviantart.com)\r\n\t\tUnsplash (unsplash.com)\r\n\r\n\tIcons:\r\n\t\tFont Awesome (fortawesome.github.com/Font-Awesome)\r\n\r\n\tOther\r\n\t\tjQuery (jquery.com)\r\n\t\thtml5shiv.js (@afarkas @jdalton @jon_neal @rem)\r\n\t\tCSS3 Pie (css3pie.com)\r\n\t\tbackground-size polyfill (github.com/louisremi)\r\n\t\tRespond.js (j.mp/respondjs)\r\n\t\tjquery.scrolly (@ajlkn)\r\n\t\tjquery.scrollzer (@ajlkn)\r\n\t\tSkel (skel.io)\r\n```\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisbobbe%2Fjekyll-theme-prologue","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrisbobbe%2Fjekyll-theme-prologue","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisbobbe%2Fjekyll-theme-prologue/lists"}