search

kognise / water.css

A drop-in collection of CSS styles to make simple websites just a little nicer
https://watercss.kognise.dev
MIT License
8.24k stars 477 forks source link

Having this as a Jekyll theme #18

Open locness3 opened 5 years ago

locness3 commented 5 years ago

Propose a Jekyll theme based on this for quick repo docs on GitHub Pages

kognise commented 5 years ago

Great idea! This is in our todo list as well

kognise commented 5 years ago

This is pretty important but will take some work. Pinning this.

kcclemo commented 4 years ago

Hello @kognise, I've put together a simple Jekyll theme that could be used as a boilerplate. This can probably be improved to pull the CSS files directly from the master branch during the build process, but this should be a good start for now.

megrxu commented 4 years ago

A hugo theme based on water.css is available at https://github.com/megrxu/hugo-water. The demo is at https://xugr.me/hugo-water. Some elements are not frequently used in a static site generator, so I didn't mention all fancy elements.

locness3 commented 4 years ago

Thanks @megrxu ! But what I'd like is a Jekyll theme for GitHub pages, just like you have the cayman etc. theme, for documenting your repo.

luke2m commented 3 years ago

Has anyone worked on this? I would be willing to try (I am not too familiar with Jekyll, but have used it a bit).

kcclemo commented 3 years ago

@luke2m I submitted a pull request a while back but haven't had time to create a more polished version of the template. Feel free to take a look at my branch and make any improvements you want.

My goal is to eventually publish a Ruby gem so that users can simply add something like water-css to their Jekyll config and the site will build with the Water CSS framework automatically.

luke2m commented 3 years ago

@kcclemo I’m sure that I’m missing something, but where is your code? kcclemo:master does not seem to be ahead of kognise:master.

kcclemo commented 3 years ago

@luke2m My original pull request was in 2019 so it is a bit out of date. You can view the files in this commit though: https://github.com/kognise/water.css/commit/03d8a6561087dc56b65d2577c63d7b9cc8c8b2d9

luke2m commented 3 years ago

It looks like you did a lot of good work. Is there a branch or repo that I can contribute to, or should I start a fresh one based on your files? If not, I think that it would be better to have a repo separate from the css.

kcclemo commented 3 years ago

At this stage, I would recommend starting from scratch. Both Water.css and Jekyll have undergone quite a bit of development since 2019. 😅

If you need any advice, feel free to reach out. I've been working with Jekyll for quite a while and love it. Here's a guide to publishing a Jekyll theme as a Gem incase you decide to go that route: https://thebot.net/threads/how-to-create-and-publish-a-jekyll-theme-gem.380424/

luke2m commented 3 years ago

@locness3 and @kognise you wanted a simple Jekyll like Cayman, right, not a personal portfolio/blog theme like Minima?

locness3 commented 3 years ago

Yes.

luke2m commented 3 years ago

My progress:

https://github.com/luke2m/watercss-jekyll https://luke2m.github.io/watercss-jekyll/

kcclemo commented 3 years ago

You're off to a great start!

luke2m commented 3 years ago

I've published to rubygems as water-css, and I would appreciate any feedback. It is definitely tailored to GitHub Pages now, but if anyone has interest in a more general purpose theme, let me know.

kcclemo commented 2 years ago

@luke2m Sorry for not looking at this sooner! It appears that the theme is pulled in as a gem correctly, but there is no layout. So, what I get is a blank site with no theme files or content at all.

Here are the build warnings I see:

Build Warning: Layout 'post' requested in _posts/2021-10-13-welcome-to-jekyll.markdown does not exist.
Build Warning: Layout 'page' requested in about.markdown does not exist.
Build Warning: Layout 'home' requested in index.markdown does not exist.

You're off to a great start though!