{"id":13610527,"url":"https://github.com/samarsault/plainwhite-jekyll","last_synced_at":"2025-05-16T15:03:36.613Z","repository":{"id":38418719,"uuid":"177436859","full_name":"samarsault/plainwhite-jekyll","owner":"samarsault","description":"A configurable portfolio-style jekyll theme for writers.","archived":false,"fork":false,"pushed_at":"2023-12-29T17:35:48.000Z","size":2888,"stargazers_count":468,"open_issues_count":22,"forks_count":481,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-03T10:13:05.288Z","etag":null,"topics":["jekyll","jekyll-site","plainwhite","theme"],"latest_commit_sha":null,"homepage":"https://samarsault.com","language":"SCSS","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/samarsault.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2019-03-24T16:00:17.000Z","updated_at":"2025-03-31T15:33:44.000Z","dependencies_parsed_at":"2024-01-22T00:00:43.430Z","dependency_job_id":null,"html_url":"https://github.com/samarsault/plainwhite-jekyll","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/samarsault%2Fplainwhite-jekyll","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samarsault%2Fplainwhite-jekyll/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samarsault%2Fplainwhite-jekyll/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samarsault%2Fplainwhite-jekyll/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samarsault","download_url":"https://codeload.github.com/samarsault/plainwhite-jekyll/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248564734,"owners_count":21125409,"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":["jekyll","jekyll-site","plainwhite","theme"],"created_at":"2024-08-01T19:01:45.575Z","updated_at":"2025-04-12T11:48:49.763Z","avatar_url":"https://github.com/samarsault.png","language":"SCSS","funding_links":["https://paypal.me/thelehhman"],"categories":["SCSS"],"sub_categories":[],"readme":"# plainwhite\n\nSimplistic jekyll portfolio-style theme for writers.\n\n**Demo**: [samarsault.com](https://samarsault.com)\n\n![plainwhite theme preview](/screenshot.png)\n\n## Installation on Github Pages\n\nAdd this line to your site's `_config.yml`:\n\n```yaml\nremote_theme: samarsault/plainwhite-jekyll\n```\n\n## Installation\n\nAdd this line to your Jekyll site's `Gemfile`:\n\n```ruby\ngem \"plainwhite\"\n```\n\nAnd add this line to your Jekyll site's `_config.yml`:\n\n```yaml\ntheme: plainwhite\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install plainwhite\n\n## Usage\n\nThe \"plainwhite\" key in \\_config.yml is used to customize the theme data.\n\n```yaml\nplainwhite:\n  name: Adam Denisov\n  tagline: Developer. Designer\n  date_format: \"%b %-d, %Y\"\n\n  social_links:\n    twitter: samarsault\n    github: samarsault\n    linkedIn: in/samarsault # format: locale/username\n```\n\n**Updating Placeholder Image**\n\nThe placeholder portfolio image can be replaced by the desired image by placing it as `assets/portfolio.png` in your jekyll website, or by changing the following line in `_config.yaml`\n\n```yaml\nplainwhite:\n  portfolio_image:  \"assets/portfolio.png\" # the path from the base directory of the site to the image to display (no / at the start)\n```\n\nTo use a different image for dark mode, e.g. with different colors that work better in dark mode, add a `portfolio_image_dark` entry in addition to the `portfolio_image`.\n\n```yaml\nplainwhite:\n  portfolio_image:      \"assets/portfolio.png\"\n  portfolio_image_dark: \"assets/portfolio_dark.png\"\n```\n\n**Comments (Disqus)**\n\nComments on posts can be enabled by specifying your disqus_shortname under plainwhite in `_config.yml`. For example,\n\n```yaml\nplainwhite:\n  disqus_shortname: games\n```\n\n**Google Analytics**\n\nIt can be enabled by specifying your analytics id under plainwhite in `_config.yml`\n\n```yaml\nplainwhite:\n  analytics_id: \"\u003c YOUR ID \u003e\"\n```\n\n**Sitemap**\n\nIt can be toggled by the following line to under plainwhite in `_config.yml`\n\n```yaml\nplainwhite:\n  sitemap: true\n```\n\n**Excerpts**\n\nExcerpts can be enabled by adding the following line to your `_config.yml`\n\n```yaml\nshow_excerpts: true\n```\n\n**Layouts**\n\n- Home\n- Page\n- Post\n\n**Navigation**\n\nNavigation can be enabled by adding the following line to your `_config.yml`\n\n```yaml\nplainwhite:\n  navigation:\n    - title: My Work\n      url: \"/my-work\"\n    - title: Resume\n      url: \"/resume\"\n```\n\n**Mobile**\n\nBy default, Plainwhite places the sidebar (logo, name, tagline etc.) above the content on mobile (narrow screens).\nTo condense it (moving some things to the bottom of the page and making the rest smaller) so it takes up less space, add the following to your `_config.yml`:\n\n```yaml\nplainwhite:\n  condensed_mobile:\n    - home\n    - post\n    - page\n```\n\nThis chooses which layouts (types of page) should be condensed on mobile screens. E.g. if you want everything but the landing page to be condensed, remove `home` from the list. This option does not affect rendering on wider screens.\n\n**Dark mode**\n\nDark mode can be enabled by setting the `dark_mode` flag in your `_config.yml`\n\nThe website will check the OS preferred color scheme and set the theme accordingly, the preference will then be saved in a cookie\n\n```yaml\nplainwhite:\n  dark_mode: true\n```\n\n![plainwhite dark theme previe](/dark.png)\n\n**Multiline tagline**\n\nTagline can be multiline in this way\n\n```yaml\nplainwhite:\n  tagline: |\n  First Line. \n\n  Second Line. \n\n  Third Line.\n```\n\n**Search-bar**\n\nSearch-bar can be enabled by adding the following line to `config.yml`\n\n```yaml\nplainwhite:\n  search: true\n```\n\nSearch is powered by [Simple-Jekyll-Search](https://github.com/christian-fei/Simple-Jekyll-Search) Jekyll plugin. A `search.json` containing post meta and contents will be generated in site root folder. Plugin JavaScript will then match for posts based on user input. More info and `search.json` customization documentation can be found in plugin repository.\n\n**Base URL**\n\nYou can specify a custom base URL (eg. example.com/blog/) by adding the following line to `_config.yaml`. Note that there is no trailing slash on the URL.\n\n```yaml\nbaseurl: \"/blog\"\n```\n\n**Language**\n\nYou can set the `lang` attribute of the `\u003chtml\u003e` tag on your pages by changing the following line in `_config.yml`:\n\n```yaml\nplainwhite:\n  html_lang: \"en\"\n```\n\n[See here for a full list of available language codes](https://www.w3schools.com/tags/ref_country_codes.asp)\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/samarsault/plainwhite-jekyll. 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 `bundle install`.\n\nYour theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your 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 your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.\nTo add a custom directory to your theme-gem, please edit the regexp in `plainwhite.gemspec` accordingly.\n\n## Donation\nIf this project help you reduce time to develop, you can give me a cup of coffee :) \n\n[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://paypal.me/thelehhman)\n\n## License\n\nThe theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## More themes\n\n- [Texture](https://github.com/samarsault/texture)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamarsault%2Fplainwhite-jekyll","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamarsault%2Fplainwhite-jekyll","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamarsault%2Fplainwhite-jekyll/lists"}