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

New theme: hugo icon #292

Closed
SteveLane opened this issue Sep 19, 2017 · 11 comments
Closed

New theme: hugo icon #292

SteveLane opened this issue Sep 19, 2017 · 11 comments

Comments

@SteveLane
Copy link

Heya - I'm providing a port of freehtml5's icon theme. Please find it at https://github.com/SteveLane/hugo-icon

@SteveLane
Copy link
Author

Sure - I'm not entirely sure on the COPYING file. By my understanding, I just need to state any changes if I made them? I'm happy to defer to (and be guided by) you and @digitalcraftsman though.

@SteveLane
Copy link
Author

@jhabdas I modified the README to make clear the attribution. By the CC BY 3.0 license and their FAQ:

Attribution — you MUST give APPROPRIATE CREDIT, PROVIDE A LINK TO FreeHTML5.co, and indicate if changes were made.

I believe that my attribution fits with their licensing.

@SteveLane
Copy link
Author

@jhabdas they don't actually provide a license with their code when you download it. I could copy the CC BY 3.0 text into a new license/copying file, but I've never seen that done before.
Going through the themes, it appears there's another ported from the same group, see elate theme, issue #187 which doesn't have that same license attached?

@digitalcraftsman
Copy link
Member

digitalcraftsman commented Sep 20, 2017

Howdie @SteveLane and @jhabdas,

thanks for porting the Icon theme to Hugo 👍 Welcome aboard!

@digitalcraftsman may be able to provide more information. He's knowledgable about licenses and licensing terms.

I'm not a lawyer but always try to interpret licences in all conscience. Let's have a look at freehtml5.co's licence:

Attribution — you MUST give APPROPRIATE CREDIT, PROVIDE A LINK TO FreeHTML5.co, and indicate if changes were made.

@SteveLane credited the original creators in the README, theme.toml, header.html partial and in the footer of each generated page. This should be more than enough to mark this bullet as checked.

However, I would add a note to the config file. In the current state it's possible to customize the copyright message in the footer (which is fine). But it should be mentioned that the credits to the original theme creators has to be kept unless the users bought the premium template.

To indicate the changes you've made while porting the theme it should be sufficient to have some sort of changelog.

Overall, feel free to reach out to the folks at www.opensource.stackexchange.com.


Now something else: I've build the theme site with the hugo-icon theme. There are only a few minor issues. Otherwise, the theme looks great!

Please add a comma between the agency and company tag in the theme.toml to make the build script's parser happy.

Furthermore, the required dimensions of the screenshot and thumbnail in the images folder aren't quite right.

Please let me know if you both have something to add.

@SteveLane
Copy link
Author

Thanks @digitalcraftsman I've added a note in the config file as suggested, as well as adding a file for changes and noting this in the readme.

I've made the theme changes as required as well.

Now, off topic, as I have your attention 😉 - I don't necessarily like having all the info in the main config, but this is the way I could quickly get the theme done for a single pager. Are you able to point me in the direction of how to do this with separate toml/yaml for each item that makes up individual sections, e.g. a separate file for each team member? I've tried playing around with data files, but struggling - you guys would probably know these themes much better than me 😄 so if you can point to particular examples, that'd be great.

@digitalcraftsman
Copy link
Member

Thanks for the quick response.

Are you able to point me in the direction of how to do this with separate toml/yaml for each item that makes up individual sections, e.g. a separate file for each team member?

Well, the bottom line are data files. You can either move parts of your config file into data files or you internationalize your theme directly with Hugo's multilingual mode which works, who's surprised, essentially like data files.

There's also an open issue that discusses the option to split up a config file. This way its easier to maintain more complex theme while keeping related options in the same file. At the end the files will be treat like a single config file.

I've tried playing around with data files, but struggling - you guys would probably know these themes much better than me

Please let us know where you exactly struggle with data files. But I think such (off topic) discussion is better suited for the forums.

@digitalcraftsman
Copy link
Member

@SteveLane please let me know if you would like to wait until you found a way to reduce the size of the config file. Otherwise, I'm fine to merge your theme in the current state.

@SteveLane
Copy link
Author

Thanks @digitalcraftsman - I need more time to think about the config, which may take a while, so I'd be happy to have it merged as is.

@digitalcraftsman
Copy link
Member

As you wish. Your theme should appear soon on the theme site. Furthermore, I'll promote your theme on Hugo's official Twitter account.

@digitalcraftsman
Copy link
Member

While looking at theme demo of your theme I noticed that the Get in touch buttons in the mission and services section link to # instead of the actual section.

@SteveLane
Copy link
Author

Yes - I just confirmed that. That's how the original theme works as well! My js is not quite up to that level just yet - I'm working on it, but I'll leave it as an open issue for the moment.

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

2 participants