{"id":16551169,"url":"https://github.com/michaelcurrin/simplest-jekyll","last_synced_at":"2025-04-12T00:40:20.140Z","repository":{"id":93179981,"uuid":"157536600","full_name":"MichaelCurrin/simplest-jekyll","owner":"MichaelCurrin","description":"A minimal Jekyll-based site on GH Pages, reduced to one page of content with a theme","archived":false,"fork":false,"pushed_at":"2024-11-25T19:59:19.000Z","size":926,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T20:21:36.155Z","etag":null,"topics":["github-pages","jekyll","minimal","quickstart","static-site","template"],"latest_commit_sha":null,"homepage":"https://michaelcurrin.github.io/simplest-jekyll/","language":"Ruby","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MichaelCurrin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-11-14T11:09:14.000Z","updated_at":"2025-03-23T04:23:10.000Z","dependencies_parsed_at":"2023-05-02T07:46:32.935Z","dependency_job_id":null,"html_url":"https://github.com/MichaelCurrin/simplest-jekyll","commit_stats":null,"previous_names":[],"tags_count":2,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fsimplest-jekyll","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fsimplest-jekyll/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fsimplest-jekyll/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fsimplest-jekyll/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MichaelCurrin","download_url":"https://codeload.github.com/MichaelCurrin/simplest-jekyll/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248501960,"owners_count":21114681,"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":["github-pages","jekyll","minimal","quickstart","static-site","template"],"created_at":"2024-10-11T19:36:31.885Z","updated_at":"2025-04-12T00:40:20.105Z","avatar_url":"https://github.com/MichaelCurrin.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Simplest Jekyll\n\u003e A minimal Jekyll-based site on GH Pages, reduced to one page of content with a theme\n\n[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/simplest-jekyll)](https://github.com/MichaelCurrin/simplest-jekyll/tags/?include_prereleases\u0026sort=semver)\n[![License](https://img.shields.io/badge/License-MIT-blue)](#license)\n\n[![Ruby](https://img.shields.io/badge/Ruby-\u003e=2.6-blue?logo=ruby\u0026logoColor=white)](https://ruby-lang.org)\n[![Jekyll](https://img.shields.io/badge/Jekyll-3.9-blue?logo=jekyll\u0026logoColor=white)](https://jekyllrb.com)\n\n\n\u003cdiv align=\"center\"\u003e\n    \n[![Use this template](https://img.shields.io/badge/Generate-Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MichaelCurrin/simplest-jekyll/generate)\n\n[![View site GH Pages](https://img.shields.io/badge/View_site-GH_Pages-blue?style=for-the-badge)](https://michaelcurrin.github.io/simplest-jekyll/)\n\n\u003c/div\u003e\n\n\n## Preview\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://michaelcurrin.github.io/simplest-jekyll/\"\u003e\n        \u003cimg src=\"/sample.png\" alt=\"Sample screenshot\" title=\"Go to website\" width=\"700\" /\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n\n## About\n\nThis is a template and live demo project. It shows how little you need to setup to get a Jekyll site on GH Pages.\n\n- [index.md](/index.md)\n    - For the homepage - the only page in this case.\n    - If you leave out this page, then `README.md` will be used as your homepage.\n- [\\_config.yml](/_config.yml)\n    - Set the theme - that handles the layout and styling.\n    - Enable Jekyll Sitemap plugin - enabling it in Gemfile is not enough. Note that other plugins will be enabled for you like optional frontmatter.\n    - Other standard values like `baseurl`, `title` and `description` have been left out of the config. When building on GH Pages, these will be inferred for you by the GH Pages gem.\n- [Gemfile](/Gemfile)\n    - This is not actually used by GH Pages, but it allows you to install the Jekyll theme locally using Bundler. \n    - Use a single gem `github-pages` if you want to match all the gems on GH Pages (which can be heavy to install). \n    - Delete this file if you don't need to run your site locally.\n\nIf you want a more full-fledged example of a multi-page site with posts, gems, layouts, etc. then checkout my [jekyll-blog-demo](https://github.com/MichaelCurrin/jekyll-blog-demo) repo. That can be used as a template and demo site too.\n\n\n## How to use this project\n\n### Setup\n\n1. Click _Use This Template_ to create a new repo in your own account. You can leave the name as `simplest-jekyll`.\n2. Enable [GitHub Pages](https://pages.github.com/) in your repo's settings. Choose to serve from `master` branch and the `/` path option.\n3. Check your repo's _environment_ tab to see when the deploy is done.\n4. Click _View deployment_ to see the live site. e.g. https://michaelcurrin.github.io/simplest-jekyll/\n\nNote that `/simplest-jekyll/index.html` is available immediately but it takes a few minutes until Github Pages makes `/simplest-jekyll/` available.\n\n### Customize\n\n- Update the `README.md` with your own details. This is not actually used in the deployed site but is visible locally and on Github.\n- Themes\n    - Edit the theme in [\\_config.yml](/_config.yml) if you want another theme.\n    - You can also use the Github Pages section of the repo Settings to preview visually. \n    - Note only themes supported by Github Pages are covered (about 10) but if you use the _remote_theme_ field in your config you can reference more themes.\n    - For installing and running locally, you'll need to make sure your [Gemfile](/Gemfile) covers the theme used in the config.\n- As with most Jekyll sites, the [index.md](/index.md) is used as the homepage. \n    - It has front matter at the top so any Liquid will be applied. \n    - Edit your `index.md` file with your own content as HTML or markdown. \n    - You can rename it to `index.html` if you only want plain HTML.\n    - You can remove the front matter at the top to remove Liquid formatting and any theming.\n- If you want to, add more pages at the root and break out any common HTMl such as header or head or navbar into `_includes` folder or `_layouts` folder (neither are covered in the scope of this project but are common for Jekyll projects).\n- See the docs and tutorials on the [Jekyll](https:jekyllrb.com/) site for more info.\n- Optionally run Jekyll locally:\n    - Install Ruby and [Bundler](https://bundler.io).\n    - Install project gems - Jekyll and the theme gem.\n    - Run Jekyll dev server.\n    - For fuller instructions see [docs](https://github.com/MichaelCurrin/jekyll-blog-demo/tree/master/docs) of Jekyll Blog Demo. You'll need to add a `Makefile` as well to match those commands.\n\n\n## Related projects\n\n\n- [![MichaelCurrin - jekyll-blog-demo](https://img.shields.io/static/v1?label=MichaelCurrin\u0026message=jekyll-blog-demo\u0026color=blue\u0026logo=github)](https://github.com/MichaelCurrin/jekyll-blog-demo) - default blog generated with Jekyll CLI. Using a theme, content, style set up, gems, and a Makefile.\n- [![MichaelCurrin - jekyll-gh-actions-quickstart](https://img.shields.io/static/v1?label=MichaelCurrin\u0026message=jekyll-gh-actions-quickstart\u0026color=blue\u0026logo=github)](https://github.com/MichaelCurrin/jekyll-gh-actions-quickstart) - using Jekyll 4, a theme, GitHub Actions, and GitHub Pages.\n- [![MichaelCurrin - jekyll-themed-site-quickstart](https://img.shields.io/static/v1?label=MichaelCurrin\u0026message=jekyll-blog-demo\u0026color=blue\u0026logo=github)](https://github.com/MichaelCurrin/jekyll-blog-demo) - minimal Jekyll site with a theme but no Gemfile.\n\n\n## License\n\nReleased under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelcurrin%2Fsimplest-jekyll","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaelcurrin%2Fsimplest-jekyll","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelcurrin%2Fsimplest-jekyll/lists"}