Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Having this as a Jekyll theme #18

Open
moeenio opened this issue Apr 7, 2019 · 17 comments
Open

Having this as a Jekyll theme #18

moeenio opened this issue Apr 7, 2019 · 17 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@moeenio
Copy link

moeenio commented Apr 7, 2019

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

@moeenio moeenio changed the title This as a Jekyll theme Having this as a Jekyll theme Apr 7, 2019
@kognise
Copy link
Owner

kognise commented Apr 8, 2019

Great idea! This is in our todo list as well

@kognise kognise added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Apr 11, 2019
@kognise
Copy link
Owner

kognise commented Apr 11, 2019

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

@kcclemo
Copy link
Contributor

kcclemo commented Oct 7, 2019

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
Copy link

megrxu commented Oct 17, 2019

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.

@moeenio
Copy link
Author

moeenio commented Oct 18, 2019

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.

@kylejrp kylejrp unpinned this issue Nov 2, 2019
@kognise kognise added hacktoberfest and removed good first issue Good for newcomers labels Oct 1, 2020
@luke2m
Copy link

luke2m commented Feb 17, 2021

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
Copy link
Contributor

kcclemo commented Feb 18, 2021

@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
Copy link

luke2m commented Feb 18, 2021

@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
Copy link
Contributor

kcclemo commented Feb 18, 2021

@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:
03d8a65

@luke2m
Copy link

luke2m commented Feb 18, 2021

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
Copy link
Contributor

kcclemo commented Feb 18, 2021

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
Copy link

luke2m commented Feb 19, 2021

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

@moeenio
Copy link
Author

moeenio commented Feb 19, 2021

Yes.

@luke2m
Copy link

luke2m commented Feb 19, 2021

@kcclemo
Copy link
Contributor

kcclemo commented Feb 19, 2021

You're off to a great start!

@luke2m
Copy link

luke2m commented Feb 26, 2021

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
Copy link
Contributor

kcclemo commented Oct 13, 2021

@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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants