Hugothemes: Theme submission: Geekblog

[xoxys]

Theme submission

Link to my theme repository: https://github.com/xoxys/hugo-geekblog

I made sure that...

• [x] the repository contains a good README.md describing my theme
• [x] an open source license has been added to LICENSE.md
• [x] all metadata have been added to theme.toml
• [x] 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
  
  
  • [ ] I tested that my theme's demo works with the content directory of gohugoio/HugoBasicExample
  
  
• [ ] 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

Is it possible to completely ignore the exampleSite folder of my theme repo? I'm using this folder to build and deploy the documentation/demo at https://hugo-geekblog.geekdocs.de/. Thanks for your help.

[digitalcraftsman]

Hello Robert,

thank you for sharing this theme with the Hugo community.

Is it possible to completely ignore the exampleSite folder of my theme repo? I'm using this folder to build and deploy the documentation/demo at hugo-geekblog.geekdocs.de.

We might don't have to ignore the exampleSite folder completely. Every folder provided by you in exampleSite will be used for the demo except the content folder. The default content for theme demos is provided by https://github.com/gohugoio/HugoBasicExample. Since your theme is focused around blogs the HugoBasicExample should work for your theme's demo fine. The data files for the authors would be used for www.theme.gohugo.io as well, but they look fine.

What is required is a config file located at exampleSite/config.{toml, yaml, json} that can be used for the demo. Would it be possible to create a config file located at exampleSite/config.{toml, yaml, json} intended for www.themes.gohugo.io while you save a dedicated config file for hugo-geekblog.geekdocs.de under a different name, e.g. at exampleSite/config-geekdocs.yml?

Changing the default location for a custom config file in the build script for www.themes.gohugo.io isn't feasible. In https://github.com/xoxys/hugo-geekblog/blob/master/.drone.yml however it shouldn't be hard to use Hugo's --config flag to point to exampleSite/config-geekdocs.yml.

---

While reviewing your theme I noticed that the stylesheet located at /main.min.css is missing. Please make sure to commit all (generated) stylesheets needed to build a working demo of your theme without the extended version of Hugo.

[xoxys]

It's not only about a different config, that's why I ask :) The theme is not working ootb from the source branch because I'm using gulp as asset pre-processor for images, svgs, sass stylesheets and so on. So if someone wants to use the theme from the git branch they need to run gulp first to create all required assets. The other way is to use a release tarball which is build and bundled during a CI driven release process.

I know that hugo has some built-in functions to handle stuff like this but I decided to separate it because I missed some features. So, main question is, is it possible to get listed in the hugo theme index with a link to an external existing demo which would be https://hugo-geekblog.geekdocs.de/? If not, that's totally fine, you will have your own rules for sure. Just wanted to ask, because e.g. Docsy seems to be handled similarly and is listed with some kind of external demo page.

Thanks a lot for your help!

[digitalcraftsman]

So, main question is, is it possible to get listed in the hugo theme index with a link to an external existing demo which would be hugo-geekblog.geekdocs.de?

There's an option in the build script to add a theme to www.themes.gohugo.io and disable its demo (as in we don't host a demo). For most submitters this is likely not desirable but could be done on request. Right now there's no way to point to an external demo from our side. But a notice with a link at the top the your theme's README should be fine.

[xoxys]

Cool, that would be totally fine for me. There is already a link in the repo readme.

[digitalcraftsman]

Your theme is now live on www.themes.gohugo.io and I've promoted it on Hugo's official Twitter account as well.

Happy hugoing

[xoxys]

Thanks again!