{"id":15288557,"url":"https://github.com/apehex/jekyll-theme-consulting","last_synced_at":"2025-04-09T13:08:59.449Z","repository":{"id":56878839,"uuid":"189716479","full_name":"apehex/jekyll-theme-consulting","owner":"apehex","description":":briefcase: A modern Jekyll template for businesses","archived":false,"fork":false,"pushed_at":"2025-01-16T14:58:39.000Z","size":6065,"stargazers_count":17,"open_issues_count":2,"forks_count":9,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-02T11:08:44.202Z","etag":null,"topics":["html-template","jekyll-theme","ruby-gem","static-site"],"latest_commit_sha":null,"homepage":"https://apehex.github.io/jekyll-theme-consulting","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apehex.png","metadata":{"files":{"readme":".github/README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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},"funding":{"github":"apehex","patreon":"apehex","custom":"https://www.paypal.me/apehex"}},"created_at":"2019-06-01T09:52:32.000Z","updated_at":"2025-01-16T14:58:40.000Z","dependencies_parsed_at":"2025-03-01T00:25:06.631Z","dependency_job_id":"08e44958-7130-4ae9-a1aa-68371b911d29","html_url":"https://github.com/apehex/jekyll-theme-consulting","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apehex%2Fjekyll-theme-consulting","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apehex%2Fjekyll-theme-consulting/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apehex%2Fjekyll-theme-consulting/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apehex%2Fjekyll-theme-consulting/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apehex","download_url":"https://codeload.github.com/apehex/jekyll-theme-consulting/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248045233,"owners_count":21038553,"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":["html-template","jekyll-theme","ruby-gem","static-site"],"created_at":"2024-09-30T15:49:58.851Z","updated_at":"2025-04-09T13:08:59.433Z","avatar_url":"https://github.com/apehex.png","language":"SCSS","funding_links":["https://github.com/sponsors/apehex","https://patreon.com/apehex","https://www.paypal.me/apehex"],"categories":[],"sub_categories":[],"readme":"# Consulting - Jekyll theme\n\n\u003e A sober, hassle-free, jekyll template for businesses.\n\nYou can preview the theme [here](https://apehex.github.io/jekyll-theme-consulting)\n\n![Consulting Theme](../assets/images/screenshot.webp \"Consulting Theme\")\n\n# Features\n\n\u003e **Responsive**: out of the box support for all screen sizes, be it smartphones, laptops, tablets...\n\n\u003e **Multilingual**: easily manage pages, menu, url, dates, sitemap in several languages\n\n\u003e **Customizable**: theme colors, menu, social items can be changed from a central config file\n\n\u003e **Many Widgets**: tabs, mini-posts, spotlight, feature listings, and more can be easily inserted without worrying about their internals\n\n\u003e **Many templates**: contact forms, navigation menus, and others can be easily inserted thanks to custom Jekyll includes\n\n\u003e **Vector images**: the theme images are vectorized, render smoothly on any display and can be dynamically styled\n\n\u003e **GDPR ready**: bundled with a cookie consent plugin and a boilerplate privacy policy compliant with GDPR\n\n\u003e **SEO ready**: sitemap, robots.txt and tags are automatically generated for the website\n\n\u003e **Light**: svg images, thumbs and lazy loading for raster images, few libraries\n\n\u003e **Performant**: parallel loading \u0026 execution of assets, support lazy-loading, minified assets, compressed critical path\n\n\u003e **Hardened**: form validation, recaptcha, verified libraries\n\n# Installation\n\nAdd this line to your Jekyll site's `Gemfile`:\n\n```ruby\ngem \"jekyll-theme-consulting\"\n```\n\nAnd add this line to your Jekyll site's `_config.yml`:\n\n```yaml\ntheme: jekyll-theme-consulting\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install jekyll-theme-consulting\n\n# Usage\n\nFor those unfamiliar with how Jekyll works, check out [jekyllrb.com](https://jekyllrb.com/) for all the details, \nor read up on just the basics of [front matter](https://jekyllrb.com/docs/frontmatter/), [writing posts](https://jekyllrb.com/docs/posts/), \nand [creating pages](https://jekyllrb.com/docs/pages/).\n\n## Initialization\n\nCopy the file `_config.yml` from the theme repository to the root of your website folder tree.\nThe following section explains what the settings impact and how to configure `_config.yml` properly.\n\n## Configuration\n\nYou can use the following custom parameters in `_config.yml`.\n\n### Site\nBoth `title` and `subtitle` are displayed side by side :\n- in the tab name\n- at the top of the page, in the header\n\n### Social\nSocial icons will appear for each url your fill in, among `facebook_url` etc.\n\n### Contact\nYour contact information can be used in contact forms, the footer or anywhere else.\n\n### Recaptcha\n\nThe contact form is validated using [google's recaptcha plugin][recaptcha-documentation].\nFirst, you need to [sign your website up] to enable the plugin.\nGoogle will provide you with a **client-side integration key**: copy it to `_config.yml` under `recaptcha.sitekey`.\n\n## Images\n\n### Lazy-Loading\n\nImages downloading \u0026 rendering can be defered until they enter the viewport.\nThis shortens the loading of the webpage, with no consequence on the displayed content since the images are off-screen.\n\nThere are 2 possibilities:\n1) using the scripts bundled with the gem\n2) depending on the browser\n\nBrowser support for lazy-loading is varying, so it is recommanded to opt for the first solution.\n\n#### Using the gem functionality\n\n- add `class=\"lazy-loading\"`\n- fill the attribute `src` with the path to the placeholder file\n- fill the attribute `data-src` with the path to the content file\n\nBefore:\n```html\n\u003cimg src=\"{{ 'assets/images/content.jpg' | absolute_url }}\" /\u003e\n```\n\nAfter:\n```html\n\u003cimg class=\"lazy-loading\" src=\"{{ 'assets/images/placeholder.jpg' | absolute_url }}\" data-src=\"{{ 'assets/images/content.jpg' | absolute_url }}\" /\u003e\n```\n\n#### Using the browser functionality\n\n- add `loading=\"lazy\"`\n\nBefore:\n```html\n\u003cimg src=\"{{ 'assets/images/content.jpg' | absolute_url }}\" /\u003e\n```\n\nAfter:\n```html\n\u003cimg loading=\"lazy\" src=\"{{ 'assets/images/content.jpg' | absolute_url }}\" /\u003e\n```\n\n\u003e This functionality is not supported by all the browsers!\n\n### Compression and file formats\n\nIt is recommanded to use the `webp` format.\n\nAt a given dimension and compression level (quality) the webp files are at least half the size with a smoother feel.\n\n## Publication\n\n### On Github Pages\n\nIn your own website's repository, edit the `_config.yml` file:\n\n```yaml\nurl: \"https://\u003cgithub-account-name\u003e.github.io/\u003crepository-name\u003e\"\n```\n\nBuild the website with:\n\n    $ JEKYLL_ENV=production bundle exec jekyll build\n\nCommit all your work to the current branch.\n\nCreate a branch named `gh-pages`:\n\n    $ git checkout -b gh-pages\n\nAnd finally replace the repository's content with the generated webpages:\n\n    $ mkdir ~/backup\n    $ mv ./* ~/backup/\n    $ mv ~/backup/.git ./\n    $ mv ~/backup/_site/* ./\n    $ git add .\n    $ git commit -m \"First draft\"\n\nThe repository's content is backup in the home directory of the user.\n\nAnd finally push to github\n\n    $ git push --u origin gh-pages\n\n### On any server\n\nIn your own website's directory, edit the `_config.yml` file:\n\n```yaml\nurl: \"https:\u003cdomain-name\u003e\"\n```\n\nBuild the website with:\n\n    $ JEKYLL_ENV=production bundle exec jekyll build\n\nCopy the content of the folder `_site` to your server, most likely in `www`.\n\nIf necessary, configure your server to serve this directory.\n\n# Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/apehex/jekyll-theme-consulting. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant][contributor-covenant] code of conduct.\n\n# Development\n\nTo set up your environment to develop this theme, run `bundle install`.\n\nTo test the theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using the theme. Add pages, documents, data, etc. like normal to test the theme's contents. As you make modifications to the theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.\n\nWhen the theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.\nTo add a custom directory to the theme-gem, please edit the regexp in `jekyll-theme-consulting.gemspec` accordingly.\n\n# Credits\n\nInspired by the work of [@ajlkn][ajlkn].\n\nUses the basic template from the [cookie consent plugin][cookieconsent].\n\nUses the [simple Jekyll search plugin][simple-jekyll-search].\n\nSpace image in the banner: the Pillars of Creation, courtesy of NASA.\n\n## License\n\nThe theme is available as open source under the terms of the [CC-BY-NC-SA-4.0](LICENSE).\n\n[ajlkn]: https://aj.lkn.io/\n[contributor-covenant]: http://contributor-covenant.org\n[cookieconsent]: https://github.com/osano/cookieconsent\n[html5up]: https://html5up.net/\n[recaptcha-documentation]: https://developers.google.com/recaptcha/intro\n[recaptcha-registering]: https://www.google.com/recaptcha/admin\n[simple-jekyll-search]: https://github.com/christian-fei/Simple-Jekyll-Search\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapehex%2Fjekyll-theme-consulting","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapehex%2Fjekyll-theme-consulting","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapehex%2Fjekyll-theme-consulting/lists"}