{"id":19633207,"url":"https://github.com/chrisbo246/jekyll-theme-overkill","last_synced_at":"2026-05-13T11:34:42.176Z","repository":{"id":77678223,"uuid":"132282403","full_name":"chrisbo246/jekyll-theme-overkill","owner":"chrisbo246","description":"A Jekyll theme with Bootstrap 4, lazyload, SVG icons, Lunr, and way too much stuffs.","archived":false,"fork":false,"pushed_at":"2020-09-03T23:28:54.000Z","size":1565,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-26T21:22:52.457Z","etag":null,"topics":["bootstrap","bootstrap4","jekyll-theme","jekyll-themes","theme"],"latest_commit_sha":null,"homepage":"https://chrisbo246.github.io/jekyll-theme-overkyll/","language":"HTML","has_issues":true,"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/chrisbo246.png","metadata":{"files":{"readme":"README.md","changelog":"History.markdown","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"authors.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-05T20:32:59.000Z","updated_at":"2019-06-09T13:18:21.000Z","dependencies_parsed_at":"2023-03-04T10:30:54.453Z","dependency_job_id":null,"html_url":"https://github.com/chrisbo246/jekyll-theme-overkill","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/chrisbo246/jekyll-theme-overkill","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbo246%2Fjekyll-theme-overkill","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbo246%2Fjekyll-theme-overkill/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbo246%2Fjekyll-theme-overkill/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbo246%2Fjekyll-theme-overkill/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrisbo246","download_url":"https://codeload.github.com/chrisbo246/jekyll-theme-overkill/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbo246%2Fjekyll-theme-overkill/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32980812,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T11:31:52.688Z","status":"ssl_error","status_checked_at":"2026-05-13T11:31:52.072Z","response_time":115,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["bootstrap","bootstrap4","jekyll-theme","jekyll-themes","theme"],"created_at":"2024-11-11T12:16:41.235Z","updated_at":"2026-05-13T11:34:42.158Z","avatar_url":"https://github.com/chrisbo246.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jekyll-theme-overkill\n\n*Jekyll-theme-overkill is a one-size-fits-all Jekyll theme for writers*. It's Jekyll's default (and first) theme. It's what you get when you run `jekyll new`.\n\n[Theme preview](https://jekyll.github.io/jekyll-theme-overkill/)\n\n![jekyll-theme-overkill theme preview](/screenshot.png)\n\n## Installation\n\nAdd this line to your Jekyll site's Gemfile:\n\n```ruby\ngem \"jekyll-theme-overkill\"\n```\n\nAnd add this line to your Jekyll site:\n\n```yaml\ntheme: jekyll-theme-overkill\n```\n\nAnd then execute:\n\n    $ bundle\n\n\n## Contents At-A-Glance\n\nJekyll-theme-overkill has been scaffolded by the `jekyll new-theme` command and therefore has all the necessary files and directories to have a new Jekyll site up and running with zero-configuration.\n\n### Layouts\n\nRefers to files within the `_layouts` directory, that define the markup for your theme.\n\n  - `default.html` \u0026mdash; The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says ` {{ content }} ` and are linked to this file via [FrontMatter](https://jekyllrb.com/docs/frontmatter/) declaration `layout: default`.\n  - `home.html` \u0026mdash; The layout for your landing-page / home-page / index-page. [[More Info.](#home-layout)]\n  - `page.html` \u0026mdash; The layout for your documents that contain FrontMatter, but are not posts.\n  - `post.html` \u0026mdash; The layout for your posts.\n\n### Includes\n\nRefers to snippets of code within the `_includes` directory that can be inserted in multiple layouts (and another include-file as well) within the same theme-gem.\n\n  - `disqus-comments.html` \u0026mdash; Code to markup disqus comment box.\n  - `footer.html` \u0026mdash; Defines the site's footer section.\n  - `google-analytics.html` \u0026mdash; Inserts Google Analytics module (active only in production environment).\n  - `head.html` \u0026mdash; Code-block that defines the `\u003chead\u003e\u003c/head\u003e` in *default* layout.\n  - `header.html` \u0026mdash; Defines the site's main header section. By default, pages with a defined `title` attribute will have links displayed here.\n\n### Sass\n\nRefers to `.scss` files within the `_sass` directory that define the theme's styles.\n\n  - `jekyll-theme-overkill.scss` \u0026mdash; The core file imported by preprocessed `main.scss`, it defines the variable defaults for the theme and also further imports sass partials to supplement itself.\n  - `jekyll-theme-overkill/_base.scss` \u0026mdash; Resets and defines base styles for various HTML elements.\n  - `jekyll-theme-overkill/_layout.scss` \u0026mdash; Defines the visual style for various layouts.\n  - `jekyll-theme-overkill/_syntax-highlighting.scss` \u0026mdash; Defines the styles for syntax-highlighting.\n\n### Assets\n\nRefers to various asset files within the `assets` directory.\nContains the `main.scss` that imports sass files from within the `_sass` directory. This `main.scss` is what gets processed into the theme's main stylesheet `main.css` called by `_layouts/default.html` via `_includes/head.html`.\n\nThis directory can include sub-directories to manage assets of similar type, and will be copied over as is, to the final transformed site directory.\n\n### Plugins\n\nJekyll-theme-overkill comes with [`jekyll-seo-tag`](https://github.com/jekyll/jekyll-seo-tag) plugin preinstalled to make sure your website gets the most useful meta tags. See [usage](https://github.com/jekyll/jekyll-seo-tag#usage) to know how to set it up.\n\n## Usage\n\n### Home Layout\n\n`home.html` is a flexible HTML layout for the site's landing-page / home-page / index-page. \u003cbr/\u003e\n\n#### Main Heading and Content-injection\n\nFrom Jekyll-theme-overkill v2.2 onwards, the *home* layout will inject all content from your `index.md` / `index.html` **before** the **`Posts`** heading. This will allow you to include non-posts related content to be published on the landing page under a dedicated heading. *We recommended that you title this section with a Heading2 (`##`)*.\n\nUsually the `site.title` itself would suffice as the implicit 'main-title' for a landing-page. But, if your landing-page would like a heading to be explicitly displayed, then simply define a `title` variable in the document's front matter and it will be rendered with an `\u003ch1\u003e` tag.\n\n#### Post Listing\n\nThis section is optional from Jekyll-theme-overkill v2.2 onwards.\u003cbr/\u003e\nIt will be automatically included only when your site contains one or more valid posts or drafts (if the site is configured to `show_drafts`).\n\nThe title for this section is `Posts` by default and rendered with an `\u003ch2\u003e` tag. You can customize this heading by defining a `list_title` variable in the document's front matter.\n\n--\n\n### Customization\n\nTo override the default structure and style of jekyll-theme-overkill, simply create the concerned directory at the root of your site, copy the file you wish to customize to that directory, and then edit the file.\ne.g., to override the [`_includes/head.html `](_includes/head.html) file to specify a custom style path, create an `_includes` directory, copy `_includes/head.html` from jekyll-theme-overkill gem folder to `\u003cyoursite\u003e/_includes` and start editing that file.\n\nThe site's default CSS has now moved to a new place within the gem itself, [`assets/main.scss`](assets/main.scss). To **override the default CSS**, the file has to exist at your site source. Do either of the following:\n- Create a new instance of `main.scss` at site source.\n  - Create a new file `main.scss` at `\u003cyour-site\u003e/assets/`\n  - Add the frontmatter dashes, and\n  - Add `@import \"jekyll-theme-overkill\";`, to `\u003cyour-site\u003e/assets/main.scss`\n  - Add your custom CSS.\n- Download the file from this repo\n  - Create  a new file `main.scss` at `\u003cyour-site\u003e/assets/`\n  - Copy the contents at [assets/main.scss](assets/main.scss) onto the `main.scss` you just created, and edit away!\n- Copy directly from Jekyll-theme-overkill 2.0 gem\n  - Go to your local jekyll-theme-overkill gem installation directory ( run `bundle show jekyll-theme-overkill` to get the path to it ).\n  - Copy the `assets/` folder from there into the root of `\u003cyour-site\u003e`\n  - Change whatever values you want, inside `\u003cyour-site\u003e/assets/main.scss`\n\n--\n\n### Customize navigation links\n\nThis allows you to set which pages you want to appear in the navigation area and configure order of the links.\n\nFor instance, to only link to the `about` and the `portfolio` page, add the following to you `_config.yml`:\n\n```yaml\nheader_pages:\n  - about.md\n  - portfolio.md\n```\n\n--\n\n### Change default date format\n\nYou can change the default date format by specifying `site.date_format`\nin `_config.yml`.\n\n```\n# Jekyll-theme-overkill date format\n# refer to http://shopify.github.io/liquid/filters/date/ if you want to customize this\njekyll-theme-overkill:\n  date_format: \"%b %-d, %Y\"\n```\n\n--\n\n### Enabling comments (via Disqus)\n\nOptionally, if you have a Disqus account, you can tell Jekyll to use it to show a comments section below each post.\n\nTo enable it, add the following lines to your Jekyll site:\n\n```yaml\n  disqus:\n    shortname: my_disqus_shortname\n```\n\nYou can find out more about Disqus' shortnames [here](https://help.disqus.com/customer/portal/articles/466208).\n\nComments are enabled by default and will only appear in production, i.e., `JEKYLL_ENV=production`\n\nIf you don't want to display comments for a particular post you can disable them by adding `comments: false` to that post's YAML Front Matter.\n\n--\n\n### Social networks\n\nYou can add links to the accounts you have on other sites, with respective icon, by adding one or more of the following options in your config:\n\n```yaml\ntwitter_username: jekyllrb\ngithub_username:  jekyll\ndribbble_username: jekyll\nfacebook_username: jekyll\nflickr_username: jekyll\ninstagram_username: jekyll\nlinkedin_username: jekyll\npinterest_username: jekyll\nyoutube_username: jekyll\ngoogleplus_username: +jekyll\nrss: rss\n\nmastodon:\n - username: jekyll\n   instance: example.com\n - username: jekyll2\n   instance: example.com\n```\n\n--\n\n### Enabling Google Analytics\n\nTo enable Google Analytics, add the following lines to your Jekyll site:\n\n```yaml\n  google_analytics: UA-NNNNNNNN-N\n```\n\nGoogle Analytics will only appear in production, i.e., `JEKYLL_ENV=production`\n\n--\n\n### Enabling Excerpts on the Home Page\n\nTo display post-excerpts on the Home Page, simply add the following to your `_config.yml`:\n\n```yaml\nshow_excerpts: true\n```\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/jekyll/jekyll-theme-overkill. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n## Development\n\nTo set up your environment to develop this theme, run `script/bootstrap`.\n\nTo test your theme, run `script/server` (or `bundle exec jekyll serve`) and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme and the contents. As you make modifications, your site will regenerate and you should see the changes in the browser after a refresh.\n\n## License\n\nThe theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisbo246%2Fjekyll-theme-overkill","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrisbo246%2Fjekyll-theme-overkill","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisbo246%2Fjekyll-theme-overkill/lists"}