{"id":13425384,"url":"https://github.com/yous/whiteglass","last_synced_at":"2025-05-14T02:04:59.063Z","repository":{"id":38857823,"uuid":"78223999","full_name":"yous/whiteglass","owner":"yous","description":"Minimal, responsive Jekyll theme for hackers","archived":false,"fork":false,"pushed_at":"2025-02-19T03:52:59.000Z","size":1042,"stargazers_count":768,"open_issues_count":7,"forks_count":198,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-05-10T15:04:27.874Z","etag":null,"topics":["blog-theme","jekyll","jekyll-theme","theme"],"latest_commit_sha":null,"homepage":"https://yous.github.io/whiteglass/","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/yous.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","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":"2017-01-06T17:13:03.000Z","updated_at":"2025-04-19T20:54:35.000Z","dependencies_parsed_at":"2024-11-19T17:36:46.541Z","dependency_job_id":"4a9607b2-e313-4745-83b9-ea1053c0e083","html_url":"https://github.com/yous/whiteglass","commit_stats":{"total_commits":190,"total_committers":13,"mean_commits":"14.615384615384615","dds":0.2421052631578947,"last_synced_commit":"b814e74dc121ea302e9c61d435d0d16c1ff10074"},"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yous%2Fwhiteglass","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yous%2Fwhiteglass/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yous%2Fwhiteglass/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yous%2Fwhiteglass/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yous","download_url":"https://codeload.github.com/yous/whiteglass/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254052692,"owners_count":22006716,"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-theme","jekyll","jekyll-theme","theme"],"created_at":"2024-07-31T00:01:11.288Z","updated_at":"2025-05-14T02:04:59.034Z","avatar_url":"https://github.com/yous.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# whiteglass\n\n[![Gem Version](https://badge.fury.io/rb/jekyll-whiteglass.svg)](https://badge.fury.io/rb/jekyll-whiteglass)\n[![CI](https://github.com/yous/whiteglass/actions/workflows/main.yml/badge.svg)](https://github.com/yous/whiteglass/actions/workflows/main.yml)\n\nMinimal, responsive Jekyll theme for hackers.\n\n![whiteglass theme](screenshot.png)\n\n## Installation\n\nAdd this line to your Jekyll site's Gemfile:\n\n``` ruby\ngem \"jekyll-whiteglass\"\n```\n\nAnd add this line to your Jekyll site's `_config.yml`:\n\n``` yaml\ntheme: jekyll-whiteglass\n```\n\nAnd then execute:\n\n``` sh\nbundle\n```\n\nOr install it yourself as:\n\n``` sh\ngem install jekyll-whiteglass\n```\n\n## Quick Start\n\n1. Go to [yous/whiteglass-template](https://github.com/yous/whiteglass-template).\n2. Click \"Use this template\" button, and then create a repository.\n3. Change the options defined in _config.yml. See [Configuration](https://github.com/yous/whiteglass-template#configuration)\n   section under whiteglass-template.\n4. Push some content, then GitHub Actions will generate the site.\n\n## Manual Setup\n\n1. Generate a new Jekyll blog:\n\n   ``` sh\n   jekyll new blog --skip-bundle\n   cd blog\n   ```\n\n2. Edit `Gemfile` to use whiteglass theme:\n\n   ``` ruby\n   gem \"jekyll-whiteglass\"\n   ```\n\n3. Edit `_config.yml` to use whiteglass theme and its plugins:\n\n   ``` yaml\n   theme: jekyll-whiteglass\n   plugins:\n     - jekyll-archives\n     - jekyll-paginate\n     - jekyll-sitemap\n\n   permalink: /:year/:month/:day/:title/\n   paginate_path: /posts/:num/\n   paginate: 5\n\n   jekyll-archives:\n     enabled:\n       - categories\n       - tags\n     layout: category_archives\n     permalinks:\n       category: /categories/:name/\n       tag: /tags/:name/\n   ```\n\n4. Copy\n   [`index.html`](https://github.com/yous/whiteglass/blob/master/index.html),\n   [`about.md`](https://github.com/yous/whiteglass/blob/master/about.md),\n   [`archives.md`](https://github.com/yous/whiteglass/blob/master/archives.md),\n   [`feed.xml`](https://github.com/yous/whiteglass/blob/master/feed.xml),\n   [`robots.txt`](https://github.com/yous/whiteglass/blob/master/robots.txt),\n   [`_data/i18n.yml`](https://github.com/yous/whiteglass/blob/master/_data/i18n.yml),\n   and [`_data/navigation.yml`](https://github.com/yous/whiteglass/blob/master/_data/navigation.yml)\n   from the theme:\n\n   ``` sh\n   rm index.md\n   curl -L -O \"https://github.com/yous/whiteglass/raw/master/{index.html,about.md,archives.md,feed.xml,robots.txt}\"\n   curl -L --create-dirs -o _data/#1 \"https://github.com/yous/whiteglass/raw/master/_data/{navigation.yml,i18n.yml}\"\n   ```\n\n5. Install gems and you're good to go! The blog will be available on\n   `http://127.0.0.1:4000`.\n\n   ``` sh\n   bundle install\n   bundle exec jekyll serve\n   ```\n\n## Upgrading\n\n### From Versions \u003c 1.9.1\n\nCopy\n[`_data/i18n.yml`](https://github.com/yous/whiteglass/blob/master/_data/i18n.yml)\nfrom the theme.\n\n## Deployment to GitHub Pages using Travis CI\n\nThis theme uses [jekyll-archives](https://github.com/jekyll/jekyll-archives) gem\nwhich is [not supported by GitHub Pages](https://help.github.com/articles/configuring-jekyll-plugins/).\nIf you want to use full features like categories and tags, I recommend you to\nuse Travis CI or other CI services.\n\nTo deploy using Travis CI, first copy the [`.travis.yml`](https://github.com/yous/whiteglass/blob/master/.travis.yml)\nof this repository. You can change `target-branch` (`gh-pages` by default) and\n`on.branch` (`master` by default) as you want. If you want further\ncustomization, see [Travis CI's documentation page](https://docs.travis-ci.com/user/deployment/pages/).\n\nYou'll see there's `github-token: $GITHUB_TOKEN`, and this is what you should\nconfigure. Go to your [personal access tokens](https://github.com/settings/tokens)\npage, and generate new token with `public_repo` or `repo` permission as you\nneed. Then go to Travis CI's settings page of your repository, and add a new\nenvironment variable `GITHUB_TOKEN` with the value of the token you generated.\n\n## Usage\n\n### Customization\n\nTo override the default structure and style of whiteglass, simply create the\nconcerned directory at the root of your site, copy the file you wish to\ncustomize to that directory, and then edit the file. e.g., to override the\n[`_includes/footer_content.html`](_includes/footer_content.html) file to add\ncontents to footer, create an `_includes` directory, copy\n`_includes/footer_content.html` from jekyll-whiteglass gem folder to\n`\u003cyour-site\u003e/_includes` and start editing that file.\n\nFor example, you can add favicons to `_includes/head_custom.html`:\n\n``` html\n\u003clink rel=\"icon\" type=\"image/x-icon\" href=\"{{ \"/favicon.ico\" | relative_url }}\"\u003e\n\u003clink rel=\"apple-touch-icon\" href=\"{{ \"/apple-touch-icon.png\" | relative_url }}\"\u003e\n\u003clink rel=\"apple-touch-icon\" sizes=\"76x76\" href=\"{{ \"/apple-touch-icon-76x76.png\" | relative_url }}\"\u003e\n\u003clink rel=\"apple-touch-icon\" sizes=\"120x120\" href=\"{{ \"/apple-touch-icon-120x120.png\" | relative_url }}\"\u003e\n\u003clink rel=\"apple-touch-icon\" sizes=\"152x152\" href=\"{{ \"/apple-touch-icon-152x152.png\" | relative_url }}\"\u003e\n\u003clink rel=\"apple-touch-icon\" sizes=\"180x180\" href=\"{{ \"/apple-touch-icon-180x180.png\" | relative_url }}\"\u003e\n```\n\nThe site's default CSS is in the gem itself,\n[`assets/main.scss`](assets/main.scss). To override the default CSS, the file\nhas to exist at your site source. Do either of the following:\n\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 \"whiteglass\";`, 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-whiteglass gem\n  - Go to your local jekyll-whiteglass gem installation directory (run `bundle show jekyll-whiteglass` 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### Locale\n\n`site.lang` is used to declare the primary language for each web page within the\nsite.\n\n`lang: en-US` sets the `lang` attribute for the site to the United States flavor\nof English, while `en-GB` would be for the United Kingdom style of English.\nCountry codes are optional and the shorter variation `lang: en` is also\nacceptable. You may want to write a post in different language, then add `lang`\nattribute to the frontmatter of that post:\n\n``` yaml\nlayout: post\ntitle: \"안녕하세요\"\nlang: ko\n```\n\nThe date format and other fixed strings are translated using the `_data/i18n.yml` file. If your language is not yet included, feel free to open a [pull request](https://github.com/yous/whiteglass/pulls).\n\n### Description\n\n`site.description` describes the site. This is mainly used in meta descriptions\nfor improving SEO. Also, you can set `description` attribute for each post:\n\n``` yaml\nlayout: post\ntitle: Awesome Post\ndescription: This is an awesome post.\n```\n\nIf you don't specify `post.description`, then `post.excerpt` will be used if it\nexist.\n\n### External URL\n\n`external-url` turns the title of your post to a link. Specify a URL which you\nwant to link to.\n\n``` yaml\nlayout: post\ntitle: Jekyll whiteglass theme\nexternal-url: https://github.com/yous/whiteglass\n```\n\nThen the title of your post would look like a link with text\n`Jekyll whiteglass theme →`. This also applies to your blog feed.\n\n### Category\n\nEach post can have `categories` attribute. It can be a string or an array. This\nwill be displayed on index, archive and each post, and provide a link to the\narchive of category.\n\n``` yaml\nlayout: post\ntitle: Awesome Post\ncategories: Misc\n```\n\n``` yaml\nlayout: post\ntitle: Another Awesome Post\ncategories:\n  - Misc\n  - Idea\n```\n\n### Tag\n\nEach post can have `tags` attribute. It can be a string or an array. This will\nbe displayed on index, archive and each post, and provide a link to the archive\nof tag.\n\n``` yaml\nlayout: post\ntitle: Awesome Post\ntags: food\n```\n\n``` yaml\nlayout: post\ntitle: Another Awesome Post\ntags:\n  - food\n  - trip\n```\n\n### Feed\n\nCreate `\u003cyour-site\u003e/feed.xml` with:\n\n``` yaml\n---\nlayout: feed\n---\n```\n\nIf you want to use another path for feed, you can specify a non-default path via\nyour site's config.\n\n``` yaml\nfeed:\n  path: atom.xml\n```\n\nThen create `\u003cyour-site\u003e/atom.xml` with the same content of `feed.xml` above.\n\n### Comments\n\nwhiteglass provides the ability to include your favourite commenting service, like [Disqus](https://disqus.com) or [Isso](https://isso-comments.de/).\n\nTo enable comments on pages and posts:\n1. Overwrite the `_includes/custom_comments_provider.html` with your custom provider of comments.\n2. Add `comments: true` to your `_config.yml`.\n\nTo disable comments on certain pages or posts specify `comments: false` in the front matter of the page or post.\n\n### Metadata for SEO\n\n#### Keywords\n\nEach post can have `keywords` attribute. This is a comma-separated list which is\nused in meta descriptions for improving SEO.\n\n``` yaml\nlayout: post\ntitle: How to configure jekyll-whiteglass\nkeywords: jekyll, whiteglass, github pages\n```\n\nYAML list is also available:\n\n``` yaml\nkeywords:\n  - jekyll\n  - whiteglass\n  - github pages\n```\n\n#### Twitter\n\n- `site.twitter_username` sets `twitter:site` and `twitter:creator` meta tag\n- `site.twitter_image` sets `twitter:image:src` meta tag\n- `page.twitter_card.type` sets `twitter:card` meta tag (default: `summary`)\n  - If `page.twitter_card.type` is `gallery`, it sets `twitter:image0`, `twitter:image1`, `twitter:image2` and `twitter:image3` meta tags with `page.twitter_card.image`, `page.twitter_card.image1`, `page.twitter_card.image2` and `page.twitter_card.image3`, respectively\n  - If `page.twitter_card.type` is `photo`, `page.twitter_card.width` sets `twitter:image:width` meta tag and `page.twitter_card.height` sets `twitter:image:height` meta tag\n- `page.twitter_card.creator` sets `twitter:creator` meta tag. It overrides `site.twitter_username`\n- `page.twitter_card.image` sets `twitter:image:src` meta tag if `page.twitter_card.type` is not `gallery`. It overrides `site.twitter_image`\n\n#### Facebook\n\n- `site.facebook_app_id` sets `fb:admins` meta tag\n- `site.facebook_page` sets `article:author` meta tag\n- `site.facebook_image` sets `og:image` meta tag\n- `page.facebook.image` sets `og:image` meta tag. It overrides `site.facebook_image`\n\n### Navigation\n\nTo define header links, add titles and URLs under the `main` key in\n`_data/navigation.yml`:\n\n``` yaml\nmain:\n  - title: \"About\"\n    url: /about/\n  - title: \"Archives\"\n    url: /archives/\n  - title: \"GitHub\"\n    url: https://github.com/yous/whiteglass\n```\n\n### Enabling Google Analytics\n\nTo enable Google Analytics, add the following lines to your Jekyll site:\n\n``` yaml\ngoogle_analytics: UA-NNNNNNNN-N\n```\n\nFor Google Analytics 4, add the following lines:\n\n``` yaml\ngoogle_analytics: G-NNNNNNNNNN\n```\n\nReplace `N`s with your specific ID.\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at\n\u003chttps://github.com/yous/whiteglass\u003e. This project is intended to be a safe,\nwelcoming space for collaboration, and contributors are expected to adhere to\nthe [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n## Development\n\nTo set up your environment to develop this theme, run `bundle install`.\n\nYour theme is setup just like a normal Jekyll site! To test your theme, run\n`bundle exec jekyll serve` and open your browser at\n`http://localhost:4000/whiteglass/`. This starts a Jekyll server using your\ntheme. Add pages, documents, data, etc. like normal to test your theme's\ncontents. As you make modifications to your theme and to your content, your site\nwill regenerate and you should see the changes in the browser after a refresh,\njust like normal.\n\n## License\n\nThe theme is available as open source under the terms of the\n[MIT License](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyous%2Fwhiteglass","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyous%2Fwhiteglass","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyous%2Fwhiteglass/lists"}