Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New theme: Huginn #665

Closed
VincentTam opened this issue Aug 1, 2019 · 8 comments

Comments

@VincentTam
Copy link

commented Aug 1, 2019

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://framagit.org/staticman-gitlab-pages/huginn

📝 Edited: I've just exported my Framagit repo to GitLab.com, where some themes are uploaded: https://gitlab.com/VincentTam/huginn.

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
  • 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.

@onedrawingperday

This comment has been minimized.

Copy link
Contributor

commented Aug 2, 2019

Hello @VincentTam

Before proceeding with the review can you please tell me a bit about the git provider that you use https://framagit.org/ ?

As you've probably seen in the theme submission guidelines we do not allow self-hosted git repositories.

Most of the themes in this repo are hosted on GitHub. We also include themes hosted on GitLab and similar, but we do not add themes living on a self-hosted repository.

From what I've seen framagit is a developer tool for hosting open source and libre code from framasoft which is:

Framasoft is a non-profit popular educational organization, a group of friends convinced that an emancipatory digital world is possible, convinced that it will arise through actual actions on real world and online with and for you!

EDIT
Right so since the repo was changed to GitLab I will test your theme further.

@VincentTam

This comment has been minimized.

Copy link
Author

commented Aug 2, 2019

As you've probably seen in the theme submission guidelines we do not allow self-hosted git repositories.

Thanks for pointing me the README. Reading the Hugo docs page about new theme submission, I didn't see the README there.

In fact, Framagit is a fork of the software GitLab hosted by a non-profit company Framasoft.
It's docs page is a better page for reference.

Framagit est la forge logicielle de Framasoft reposant sur le logiciel Gitlab.

Elle est ouverte à tous, dans la limite de 42 projets par personne.

Here's another piece of info about the name of Framasoft: Pyromaths/pyromaths#26.

le MA de FRAMAGIT signifie mathématiques :) (à l'origine, framasoft est un annuaires de logiciels SOFT pour le français FRA et les maths MA) ;

Framasoft = French + math + software

Anyways, lemme change it to GitLab.com.

@onedrawingperday

This comment has been minimized.

Copy link
Contributor

commented Aug 2, 2019

@VincentTam

Thank you for changing the repo.

When I test your theme's demo with the Hugo Themes Build Script it renders, however I have noticed the following issues:

  1. Please replace all instances of https://framagit.org/staticman-gitlab-pages/hugo-theme-huginn/ with https://gitlab.com/VincentTam/huginn so that the links in theme.toml and in your theme's README resolve to the new repo.

  2. The description parameter in line 7 of theme.toml needs to be only plain text. So please remove the markdown link to the Pelican theme that inspired you. You already mention this theme in the README there is no need to mention it in the description.

  3. Your theme's demo content will be inherited from the Hugo Basic Example repo. Due to the requirements of various themes in that repo we have a /posts/ section with the actual content files and a /post/ section with symlinks to the content files under /posts/.

The way that you have chosen to populate your posts list on the index page of the theme demo has the side effect of displaying all content twice, both the actual content under https://github.com/gohugoio/hugoBasicExample/content/posts/ and the symlinks under https://github.com/gohugoio/hugoBasicExample/content/post/.

To fix the above we need to use the mainSections internal parameter.

So please replace line 2 of /layouts/index.html to the following:

{{- $paginator := .Paginate (where site.RegularPages "Type" "in" site.Params.mainSections) 5 -}}
{{- range $paginator.Pages -}}

Once you do the above please let me know so that I can test your theme further.

Thanks

@VincentTam

This comment has been minimized.

Copy link
Author

commented Aug 2, 2019

@onedrawingperday Thanks for your code example. Suggestion done @dc5a80f7a.

@onedrawingperday

This comment has been minimized.

Copy link
Contributor

commented Aug 2, 2019

@VincentTam

Thank you for committing the changes.

There is only the matter of the link in the footer that still points to https://framagit.org/staticman-gitlab-pages/huginn I suggest that from within the huginn/tree/master/i18n folder you perform a recursive search & replace with your favorite editor so that you make the link point to the GitLab repo of your theme.

@VincentTam

This comment has been minimized.

Copy link
Author

commented Aug 2, 2019

@onedrawingperday Excuse me for such careless mistakes. Done at my recent commit. Now, the only reference to Framagit is the Framagit bot of Staticman called "@staticmanlab1". All screenshots have been replaced with a GitLab.com domain name. Thanks for your feedback.

@onedrawingperday

This comment has been minimized.

Copy link
Contributor

commented Aug 2, 2019

@VincentTam Thanks you!

@digitalcraftsman This theme is ready to be added to the showcase when you can.

@digitalcraftsman

This comment has been minimized.

Copy link
Member

commented Aug 3, 2019

Hello Vincent,

thank you for sharing this theme with the Hugo community. Your theme should be listed soon on the themes site.

Furthermore, I'll promote your theme on Hugo's official Twitter account.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.