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

New Theme (port): Athena #415

Closed
10 tasks done
mtn opened this issue Aug 30, 2018 · 13 comments
Closed
10 tasks done

New Theme (port): Athena #415

mtn opened this issue Aug 30, 2018 · 13 comments

Comments

@mtn
Copy link

mtn commented Aug 30, 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.

Link to my theme repository: https://github.com/mtn/athena-hugo-theme

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.

I'm not totally sure what to do on the last one (generating assets). Do I need to manually copy the resources from the rendered site to the theme?

@onedrawingperday
Copy link
Contributor

onedrawingperday commented Aug 30, 2018

@mtn

Yes. You need to commit the resources folder with all its contents in your theme’s repo after running Hugo server not from the published site.

Thanks for your submission!

@mtn
Copy link
Author

mtn commented Aug 30, 2018

@onedrawingperday

I think this is done, please let me know if there's anything I missed. Thank you!

@onedrawingperday
Copy link
Contributor

@mtm

Now your theme will work in the basic version of Hugo.

@digitalcraftsman will look into your theme further once he can.

@digitalcraftsman
Copy link
Member

digitalcraftsman commented Sep 12, 2018

@mtn could you please remove the exampleSite/themes folder? The build script will change the directory structure anyway. For theme users it's advised to set the path for the theme in the config file to ../..

@onedrawingperday have you been able to generate the demo with the added ressource folder? Locally, I'm using Hugo v0.48 (not the extended version as on the server). The demo button is shown but points to a blank page (or 404 page on the actual website).

Edit: a demo is generated but the stylesheets are missing (see https://themes.gohugo.io/theme/athena-hugo-theme/)

@onedrawingperday
Copy link
Contributor

onedrawingperday commented Sep 12, 2018

@digitalcraftsman

No I didn't test this theme. I only replied to the author's question regarding committing the /resources/

I viewed the source of the demo and I noticed that the stylesheet has the following URL:
<link rel="stylesheet" href="https://themes.gohugo.io/main.css" media="screen">

I think that the author needs to use .RelPermalink for the stylesheet to generate the correct URL.

Also the same needs to be done for any other theme assets that are generated through Hugo Pipes.

@mtn
Copy link
Author

mtn commented Sep 12, 2018

Yep, those are mistakes on my part. I'll make an update and ping you guys once it's fixed.

@mtn
Copy link
Author

mtn commented Sep 12, 2018

@onedrawingperday Should I just use .RelPermalink in place of .Permalink everywhere?

@onedrawingperday
Copy link
Contributor

onedrawingperday commented Sep 12, 2018

No.

Only use .RelPermalink for resources that were created with Hugo Pipes.

See the commit of the updated README #421

It has some useful links.

@mtn
Copy link
Author

mtn commented Sep 12, 2018

@onedrawingperday Thanks for directing me to that. Both changes are now on master.

cc @digitalcraftsman

@onedrawingperday
Copy link
Contributor

@mtn The themes were updated just now and if you look at https://themes.gohugo.io/theme/athena-hugo-theme/ you will see that there are no posts in your demo.

You only have markdown-sample.md under /content and it is a draft. Please undraft it.
Also the Home link in your header.html partial has the following:
<a class="italic h4 bold no-underline" href="{{ .Site.BaseURL }}/">
You need to remove the slash after {{ .Site.BaseURL }}
It is not needed.

Other than that your demo looks fine.

Do the above changes and let me know.

Thanks.

@mtn
Copy link
Author

mtn commented Sep 13, 2018

@onedrawingperday done

@onedrawingperday
Copy link
Contributor

@mtn Good.

@digitalcraftsman The Athena Theme is ready to be promoted with a Tweet and this submission can be closed.

@digitalcraftsman
Copy link
Member

Thanks @onedrawingperday for your review 👍

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

3 participants