{"id":30525538,"url":"https://github.com/brennanbrown/watery","last_synced_at":"2025-08-26T22:33:22.007Z","repository":{"id":39986256,"uuid":"309196530","full_name":"brennanbrown/watery","owner":"brennanbrown","description":"🚰 A minimalist, bare-bones theme for Jekyll only using the Water.css framework while still following the best practices for accessibility and search-engine optimization.","archived":false,"fork":false,"pushed_at":"2025-08-25T14:36:01.000Z","size":123,"stargazers_count":14,"open_issues_count":0,"forks_count":8,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-25T16:23:22.798Z","etag":null,"topics":["css","jekyll","jekyll-theme","lighthouse-score","template","watercss"],"latest_commit_sha":null,"homepage":"https://watery.netlify.app/","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/brennanbrown.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"zenodo":null},"funding":{"ko_fi":"brennan"}},"created_at":"2020-11-01T21:58:01.000Z","updated_at":"2025-08-25T14:36:04.000Z","dependencies_parsed_at":"2025-08-25T16:12:45.500Z","dependency_job_id":"4bfb7b4b-e3ae-4f94-9970-5b42ba4a29be","html_url":"https://github.com/brennanbrown/watery","commit_stats":null,"previous_names":[],"tags_count":4,"template":true,"template_full_name":null,"purl":"pkg:github/brennanbrown/watery","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brennanbrown%2Fwatery","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brennanbrown%2Fwatery/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brennanbrown%2Fwatery/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brennanbrown%2Fwatery/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brennanbrown","download_url":"https://codeload.github.com/brennanbrown/watery/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brennanbrown%2Fwatery/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272124627,"owners_count":24877705,"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","status":"online","status_checked_at":"2025-08-25T02:00:12.092Z","response_time":1107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["css","jekyll","jekyll-theme","lighthouse-score","template","watercss"],"created_at":"2025-08-26T22:33:06.700Z","updated_at":"2025-08-26T22:33:21.999Z","avatar_url":"https://github.com/brennanbrown.png","language":"HTML","funding_links":["https://ko-fi.com/brennan"],"categories":[],"sub_categories":[],"readme":"\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/brennanbrown/watery\"\u003e\n    \u003cimg src=\"https://i.postimg.cc/R04gwg7n/logo.png\" alt=\"Logo\" width=\"80\" height=\"80\"\u003e\n  \u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003eWatery Theme for Jekyll\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    A bare-bones template to help you get started on your next blog or website.\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/brennanbrown/watery\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003cstrong\u003e\u003ca href=\"https://watery.netlify.app\"\u003eView Demo\u003c/a\u003e\u003c/strong\u003e\n    ·\n    \u003ca href=\"https://github.com/brennanbrown/watery/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/brennanbrown/watery/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\u003c!-- BADGES --\u003e\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://app.netlify.com/sites/watery/deploys\"\u003e\u003cimg src=\"https://api.netlify.com/api/v1/badges/d0dec072-0493-4b48-9f66-739482a9c80f/deploy-status\" alt=\"Netlify Status\"\u003e\u003c/a\u003e\n\u003cimg alt=\"GitHub code size in bytes\" src=\"https://img.shields.io/github/languages/code-size/brennanbrown/watery\"\u003e\n\u003cimg alt=\"GitHub repo size\" src=\"https://img.shields.io/github/repo-size/brennanbrown/watery\"\u003e\n\u003ca href=\"https://github.com/brennanbrown/watery/search?l=html\"\u003e\u003cimg alt=\"GitHub top language\" src=\"https://img.shields.io/github/languages/top/brennanbrown/watery\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/brennanbrown/watery/issues\"\u003e\u003cimg alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues/brennanbrown/watery\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/brennanbrown/watery/commits/main\"\u003e\u003cimg alt=\"GitHub last commit\" src=\"https://img.shields.io/github/last-commit/brennanbrown/watery\"\u003e\u003c/a\u003e\n\u003ca href=\"https://app.fossa.com/projects/git%2Bgithub.com%2Fbrennanbrown%2Fwatery?ref=badge_shield\" alt=\"FOSSA Status\"\u003e\u003cimg src=\"https://app.fossa.com/api/projects/git%2Bgithub.com%2Fbrennanbrown%2Fwatery.svg?type=shield\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/brennanbrown/watery/blob/main/LICENSE\"\u003e\u003cimg alt=\"GitHub license\" src=\"https://img.shields.io/github/license/brennanbrown/watery\"\u003e\u003c/a\u003e\n\u003ca href=\"https://watery.netlify.app\"\u003e\u003cimg alt=\"Website\" src=\"https://img.shields.io/website?down_color=red\u0026down_message=Offline%21\u0026label=Status\u0026up_color=darkgreen\u0026up_message=Online%21\u0026url=https%3A%2F%2Fwatery.netlify.app\"\u003e\u003c/a\u003e\n\u003ca href=\"https://rubygems.org/gems/watery\"\u003e\u003cimg alt=\"RubyGems\" src=\"https://img.shields.io/gem/v/watery.svg\"\u003e\u003c/a\u003e\n\u003cbr /\u003e\n\u003ca href=\"https://github.com/brennanbrown?tab=followers\"\u003e\u003cimg alt=\"GitHub followers\" src=\"https://img.shields.io/github/followers/brennanbrown?label=Follow%20Me%21\u0026style=social\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/brennanbrown/watery/watchers\"\u003e\u003cimg alt=\"GitHub watchers\" src=\"https://img.shields.io/github/watchers/brennanbrown/watery?label=Watch%21\u0026style=social\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/brennanbrown/watery/stargazers\"\u003e\u003cimg alt=\"GitHub stars\" src=\"https://img.shields.io/github/stars/brennanbrown/watery?label=Star%21\u0026style=social\"\u003e \u003c/a\u003e\n  \u003ca href=\"https://github.com/brennanbrown/watery/network/members\"\u003e\u003cimg alt=\"GitHub forks\"src=\"https://img.shields.io/github/forks/brennanbrown/watery?label=Fork%21\u0026style=social\"\u003e\u003c/a\u003e\n  \u003c/p\u003e\n\n [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/brennanbrown/watery)\n\n## Quickstart (theme gem)\n\nUse Watery as a reusable theme in your Jekyll site.\n\n1) Add to your site `Gemfile`:\n```ruby\ngem \"jekyll\", \"~\u003e 4.3\"\ngem \"watery\", \"~\u003e 0.1\"\n\ngroup :jekyll_plugins do\n  gem \"jekyll-feed\"\n  gem \"jekyll-seo-tag\"\n  gem \"jekyll-paginate\"\n  gem \"jekyll-sitemap\"\nend\n```\n\n2) Configure your site `_config.yml`:\n```yml\ntheme: watery\nplugins:\n  - jekyll-feed\n  - jekyll-seo-tag\n  - jekyll-paginate\n  - jekyll-sitemap\n\npaginate: 5\npaginate_path: \"/page/:num/\"\n```\n\n3) Build and serve:\n```bash\nbundle install\nbundle exec jekyll serve\n```\n\n### Install from RubyGems (optional)\n\nWatery is published on RubyGems:\n\n```bash\ngem install watery\n```\n\nRuby projects should prefer adding it to your site `Gemfile` (see Quickstart above).\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n\n**Watery** is a minimalist, bare-bones theme for the popular JAMstack file-based CMS Jekyll that only uses the `\u003c80kb` [**Water.css** framework](https://github.com/kognise/water.css) (hence the name!), while still following the best practices possible for accessibility and search-engine optimization.\n\nI created this because I wasn't able to find an up-to-date starter/skeleton theme for Jekyll. Even the default theme, Minima, uses the large Bootstrap framework.\n\nThis project is aimed towards those curious about using Jekyll for the first time, and want to build from as close to scratch as possible. Alternatively, it still has all the features required for creating a hassle-free, informational website or blog in just a few clicks.\n\nAs of November 1st, 2020, with \u003e70 posts on Watery, the website scores a perfect 100 in Performance, Accessibility, Best Practices, and SEO on an audit with [**Google Lighthouse**](https://developers.google.com/web/tools/lighthouse).\n\nFor an example, you can view my blog, [**Journal.kim/**](https://journal.kim/) using this theme with the [Writ.css](https://writ.cmcenroe.me/) framework.\n\n**New!** Change the CSS framework with a single button, thanks to [**Dropin Minimal CSS**](https://github.com/dohliam/dropin-minimal-css).\n\n![Watery Screen Shot](https://i.postimg.cc/C1XhZB3d/Watery-Screenshot.png)\n\n### Features\n\nDespite Watery's minimalist nature, there are a few interesting features that have been added:\n\n- A fully customizable and empty `_BLANK_config.yml` to make getting up-and-running easy.\n- Having a `_pages` collection for easier organization.\n- Auto-generated links in navigation to all pages in `_pages`.\n- Auto-generated [tags page](https://watery.netlify.app/tags) that lists all tags used by all posts in chronological order.\n- An author bio at the end of each post. (Located in `_inclues/author.html`)\n- Full [Rouge](https://github.com/rouge-ruby/rouge) support for syntax code highlighting. (Currently using `base16.solarized.light`)\n- Auto-generated RSS feed, sitemap, accessibility features, and search-engine optimization.\n\n## Installation\n\n### Prerequisites\n\nJekyll requires the following:\n\n- Ruby version **3.0** or higher (3.2+ recommended)\n- RubyGems and Bundler\n- GCC and Make (build tools)\n\nNote: Ruby 3 no longer bundles Webrick. This project declares `webrick` in the `Gemfile`, so `bundle exec jekyll serve` will work out of the box.\n\nSee [Requirements](https://jekyllrb.com/docs/installation/#requirements) for guides and details.\n\n### Instructions\n\n1. Install all [prerequisites](https://jekyllrb.com/docs/installation/).\n2. Install the jekyll and bundler [gems](https://jekyllrb.com/docs/ruby-101/#gems).\n\n```\ngem install jekyll bundler\n```\n\n3. Clone this repository.\n\n```\ngit clone https://github.com/brennanbrown/watery.git\n```\n\n4. Change into your new directory.\n\n```\ncd watery\n```\n\n5. Install gems from the `Gemfile`.\n\n```\nbundle install\n```\n\nOn macOS/Linux, this will regenerate `Gemfile.lock` for your platform (the repo previously contained a Windows-specific lockfile). Commit the updated lockfile.\n\n6. Build the site and make it available on a local server.\n\n```\nbundle exec jekyll serve\n```\n\n7. Browse to [http://localhost:4000](http://localhost:4000)\n\nIf you encounter any errors during this process, check that you have installed all the prerequisites in [Requirements](https://jekyllrb.com/docs/installation/#requirements).\n\nIf you still have issues, see [Troubleshooting](https://jekyllrb.com/docs/troubleshooting/#configuration-problems).\n\n## Getting Started\n\nOnce you have Jekyll up-and-running, there are only a few steps needed to make this theme your own:\n\n1. Fill out the `_BLANK_config.yml` configuration file and replace the current `_config.yml`\n2. Remove the `example_posts` folder in `_posts` and start writing your own!\n3. Modify or remove the pages in `_pages` to however you see fit.\n4. _(Optional)_ Modify or remove this `README.md` with information about your own project or blog.\n5. _(Optional)_ Modify the CSS files in the `assets` folder to customize the site.\n6. _(Optional)_ Remove `switcher.js` from the `assets` folder, choose [**another framework**](https://github.com/dbohdan/classless-css) to use!\n\n### Optional extras\n\n- Optional link checking in CI with Lychee. See `.github/workflows/link-check.yml` and `.lycheeignore`.\n- Optional Sass scaffolding (no requirement): see `assets/scss/sample.scss` and notes in `Gemfile` comments.\n- Optional pagination with `jekyll-paginate-v2` (not GitHub Pages–safe). See `docs/PAGINATION.md`.\n\n## Documentation\n\n- Changelog: `docs/CHANGELOG.md`\n- Theme gem guide (extraction/publish playbook): `docs/GEM-THEME-GUIDE.md`\n- Pagination options and guidance: `docs/PAGINATION.md`\n- Collections usage notes: `docs/COLLECTIONS.md`\n\nAlso see `theme/README.md` for gem-specific consumer instructions.\n\n\u003c!-- ROADMAP --\u003e\n\n## Roadmap\n\nThere are several features that I'm still planning to create and integrate, including:\n\n- Create a [Theme Gem](https://jekyllrb.com/docs/themes/#publishing-your-theme)\n- Add easy and automatic buttons to [\"Deploy to Netlify\"](https://docs.netlify.com/site-deploys/create-deploys/#deploy-to-netlify-button), Heroku, etc.\n- Add Travis continious integration checks\n- Add additional documentation for creating custom collections and auto generated pages\n- Add the following files: `robots.txt`, `asset-manifest.json`, `light.css.map`\n- Add more example posts and articles\n\nSee the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a list of proposed features (and known issues).\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003c!-- LICENSE --\u003e\n\n## License\n\nDistributed under the MIT License. You can use this project however you see fit without needing to give attribution.\n\nSee `LICENSE` for more information.\n\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fbrennanbrown%2Fwatery.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fbrennanbrown%2Fwatery?ref=badge_large)\n\n## Resources\n\nWhile creating this theme, I came across a lot of helpful and hard-to-find resources. If you'd like to dive deeper into Jekyll, check them out:\n\n- Jumping Into Jekyll: \u003chttps://dev.to/brennan/jumping-into-jekyll-4o9h\u003e\n- Jekyll Cheatsheet: \u003chttps://devhints.io/jekyll\u003e\n- Course on Jekyll: \u003chttps://learn-the-web.algonquindesign.ca/topics/jekyll/\u003e\n- Jekyll for Designers: \u003chttp://simpleprimate.com/jekyll-for-designers/index.html\u003e\n- Dynamic Copyright on Jekyll: \u003chttps://michaelsoolee.com/jekyll-copyright/\u003e\n- Creating breadcrumbs in Jekyll: \u003chttps://jekyllcodex.org/without-plugin/breadcrumbs/\u003e\n- Display all items from ALL collections: \u003chttps://stackoverflow.com/questions/31171041/listing-all-collections-in-jekyll\u003e\n\n### Other Resources\n\n- For markdown previews: \u003chttps://jaspervdj.be/lorem-markdownum/\u003e\n- Case Study on webfont performance: \u003chttps://www.keycdn.com/blog/web-font-performance\u003e\n- An extensive `.gitignore`: \u003chttps://miguelmota.com/bytes/extensive-gitignore/\u003e\n- The inspriation for this project: \u003chttp://motherfuckingwebsite.com/\u003e\n\n## Credit\n\n[**Water.css**](https://watercss.kognise.dev/) was created by [Kognise](https://github.com/kognise).\n\n[**Dropin Minimal CSS**](https://github.com/dohliam/dropin-minimal-css) was created by [Dohliam](https://github.com/dohliam).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrennanbrown%2Fwatery","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrennanbrown%2Fwatery","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrennanbrown%2Fwatery/lists"}