Theme Submission: Cookbook
deranjer opened this issue · 0 comments
Theme submission
Please make sure that you have read the theme submission guidelines before submitting a theme. The guidelines provide all relevant information and requirements that have to be fulfilled before the submission. We strongly suggest that you test your theme with the Hugo Themes Build Script before submitting the theme for review. If a submission does not meet the criteria mentioned in the README it will be closed. You may re-submit once you fix the problems with your submission. However, please note that we have limited resources and can not provide help for general web development issues. For Hugo support questions please refer to the dedicated support forum.
Please tick the relevant boxes for your theme in the checklist below:
Link to my theme repository: https://github.com/deranjer/hugo-cookbook
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 inexampleSite/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
andPostCSS
that I have committed the/resources
directory with all generated assets, for my theme to work in the basic version of Hugo
N.B. By submitting a theme to the Hugo Themes Showcase you understand that you need to maintain your theme. If a theme demo breaks and remains broken then at some point it will be removed from the list without prior warning. If you no longer wish to maintain a theme please let us know.
Feel free to ask questions. We're glad to help.
Please Note: This is a specialized theme. It does not display in the expected manner when using it with the Hugo Basic Example. I have an exampleSite in the repo for users to try, and a link to a live site on my README.md hosted on netlify (with Hugo v0.80.0) with example data on it.