Skip to content
This repository has been archived by the owner on Jul 5, 2021. It is now read-only.

New Theme : Hugo Lime #413

Closed
10 tasks done
heyarviind opened this issue Aug 25, 2018 · 21 comments
Closed
10 tasks done

New Theme : Hugo Lime #413

heyarviind opened this issue Aug 25, 2018 · 21 comments

Comments

@heyarviind
Copy link

heyarviind commented Aug 25, 2018

Theme submission

Before submitting a theme please make sure you've read the README.md. It describes in detail what information are needed and which requirements have to be fulfilled for the submission. The check list below can help you.

https://github.com/uicardiodev/hugo-lime

I made sure that...

  • the repository contains a good README.md describing my theme
  • an open source license has been added to LICENSE.md
  • all metadata have been added to theme.toml
  • screenshots have been added in the images/ folder with the required dimensions
  • in case I'm using a customized demo via the exampleSite folder that
  • https://example.com is set as base url in exampleSite/config.{toml, yaml, json} to avoid the abuse of unused domains
  • the site's content is as neutral as possible (contains no ads etc.) and reflects the features of my theme
  • I tested my theme against the gohugoio/HugoBasicExample
  • I've checked the developer tools' console in my browser for error messages
  • in case my theme is using Hugo Pipes features like toCSS and PostCSS that I have committed the /resources directory with all generated assets, for my theme to work in the basic version of Hugo

Feel free to ask questions. We're glad to help.

@digitalcraftsman
Copy link
Member

Hello @heyarviind,

thank you for submitting another beautiful theme to us 👍

I've tested your theme with the build script for the Hugo theme site that also generates a demo for the theme. When you make use of the exampleSite folder please make sure that

  • you add a content folder inside exampleSite. Even if your theme is a one-page theme and doesn't make use of content files Hugo expects a content folder under all circumstances. You can make the content folder trackable by adding a empty dummy file like exampleSite/content/.gitkeep
  • you provide a config file in the exampleSite folder. Once you make use of exampleSite you have to provide all necessary files for a working Hugo site yourself as Hugo doesn't fall back to the default setup

@heyarviind
Copy link
Author

Hey @digitalcraftsman,

Sorry for the mistakes, I've resolved the issues. Please have a look at the repo again

Cheers

@digitalcraftsman
Copy link
Member

While having another looking at your theme I noticed that you're making us of Hugo's SCSS generation feature. Currently, the extended version of Hugo, which includes the SCSS generator, isn't supported by our hoster netlify.com. They're using a tool to fetch the latest Hugo release, but it can't distinguish between the normal Hugo version and the extended version of Hugo.

A pull request to fix this problem has already been submitted. But it can take some time once Netlify also updates their build image that is used for the generation deployments.

According to this comment a possible workaround is to let Git track the resources/_gen/assets folder.

@heyarviind
Copy link
Author

@digitalcraftsman I can compile and use the CSS for the demo if you say?

@digitalcraftsman
Copy link
Member

For now you've to compile the CSS files yourself and add resources/_gen/assets that contains the generated to the Git repository. Because the extended version of Hugo isn't available during the build of the theme site Hugo is unable to compile the SCSS files on it's own.

@heyarviind
Copy link
Author

@digitalcraftsman I've added compiled CSS, please let me know if there is anything to be corrected

@heyarviind
Copy link
Author

@digitalcraftsman I am waiting for the theme to be added on hugo directory.... is there anything left from my side?

@onedrawingperday
Copy link
Contributor

@heyarviind You need to commit the /resources/ directory along with all of its contents for the theme's demo to be generated on the website, not the /assets/ directory that contains the uncompliled SCSS.

Also please review the updated README

Please do the above and let me know.

Thanks.

@heyarviind
Copy link
Author

@onedrawingperday I tried build script but something was not working on my end, so I've added resource folder and changed files as you've mentioned. Please have a look

@onedrawingperday
Copy link
Contributor

@heyarviind

First of all please delete the .DS_Store files that are under every folder below the newly commited /resources/ directory. Also add this file in a .gitignore file. This file contains metadata from your Mac and it's not a good idea to have it visible in public.

Then please review the Hugo Theme's updated README Common Permalink Issues because your demo is affected.

You need to use .RelPermalink for Hugo Pipes Assets.

Please do the above and let me know.

@heyarviind
Copy link
Author

@onedrawingperday Sorry for the .DS_Store issue again, I've deleted all the .DS_Store files.

I've also replaced .Permalink to .RelPermalink. Hope this time things work fine :)

@onedrawingperday
Copy link
Contributor

@heyarviind Thanks for making the changes. All is good with your theme now and there are no more errors on my end.

However I am not sure about what is the practice for the BUY NOW button that you have included in your header and also about the extra features of the PRO VERSION of your theme, that are mentioned in the README. The license of the free version of your theme is the standard MIT.

So I am tagging @digitalcraftsman and @bep to offer their opinion about the promotion of the PRO VERSION of your theme.

Also here is the link of your theme's repo to make it easier for them to see it for themselves:
https://github.com/uicardiodev/hugo-lime

@heyarviind
Copy link
Author

@onedrawingperday I develop free and pro version of the themes, so I am just submitting the free version to Hugo. I think adding little about pro version in the description has no harm. After all, it encourages me to develop more and professional looking themes for Hugo

@onedrawingperday
Copy link
Contributor

@heyarviind

Sure, but this is not my call.

I tagged the others to have a look at your theme's README about the features of the PRO VERSION as well as the BUY NOW button.

If @bep and @digitalcraftsman are fine your theme can be added as is. If they request changes about the promotion, they will let you know.

@onedrawingperday
Copy link
Contributor

@heyarviind

Also I want to note that in your previous theme submission that I also reviewed the promotion of the PRO version was more subtle and you only mentioned it in the README. There is no BUY NOW button in the Demo.

https://themes.gohugo.io/hugo-sodium-theme/

@digitalcraftsman
Copy link
Member

digitalcraftsman commented Sep 15, 2018

Hello @heyarviind,

your theme's demo is working fine. Regarding the promotion of a paid version I would refer to a similar discussion for Themefisher themes (e.g. navigator, airspace), especially this comment by Bjørn Erik.

The MIT license is standard license and commonly. For me the README is formulated neutral. You're listing the differences between the free and pro version of the theme and linking to the pro version in a non-instrusive manner. Hence it should be (IMO) in accordance to Bjørn Erik's linked comment from above.

However, I'm not sure about the "Buy now" button in the demo. This sounds like the theme isn't free which stands in contrast to the MIT license. A more neutral version could be "Show pro version". However, I would like to hear @bep's opinion as well for a final decision.

/ping @bep

@bep
Copy link
Member

bep commented Sep 15, 2018

I agree with you @digitalcraftsman -- "buy now" is hinting that this is a "try, then buy" kind of program. Which is fine, but not here.

@heyarviind
Copy link
Author

@digitalcraftsman @onedrawingperday @bep I've removed "buy now" button from the demo, please have a look. I don't think there is any other issue left with this theme

@digitalcraftsman
Copy link
Member

digitalcraftsman commented Sep 17, 2018

Now I'm fine with this decision and your theme in general. What about you @bep?

@bep
Copy link
Member

bep commented Sep 17, 2018

Looks good.

@digitalcraftsman
Copy link
Member

Your theme should appear soon on Hugo's theme site. Next, I'll promote your theme on Hugo's official Twitter account.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants