migrate website to hugo

[robbymilo]

Initial port of the darktable website to hugo. See #113 for background.

I've been able to convert most of the markdown and layout files to a hugo compatible format. There are numerous ways to accomplish things with hugo, so I'd love recommendations if there's a better/easier way to do something here.

Notes:

• Uses hugo version 0.83.1
• Uses GitHub actions to deploy a Netlify preview at https://hugo-robbymilo--darktable.netlify.app (can consider using Netlify's open source plan)
• Adds responsive images for some of the ledes/backgrounds. Note I am not committing most of the rendered thumbnails to git despite hugo's recommendation.
• I've kept the old theme files and .py scripts for reference, these can probably be removed.

To-do list for parity with the current website:

• Handle posts with different slugs - either redirect old urls (alias?) or add a slug param with the proper value. For example, the current site renders as /2020/08/darktable-321-released/, but hugo renders as /2020/08/darktable-3.2.1-released/
• Current search allows for searching the lua api - where are these located? Are these pages a different site?
• Correct footer menu links
• Check for correct rendering of markdown - I've spot checked some of the articles and it looks like there may be some differences in how hugo (goldmark) renders markdown. For example, hugo does not render markdown within HTML. I've solved this by adding a shortcode. See https://github.com/robbymilo/dtorg/blob/robbymilo/hugo/content/blog/2020-08-10-darktable-3.2/index.md for an example with shortcodes.
• Check for broken links/images

To test locally:

• Make sure you have the correct hugo version installed. Run make server and navigate to localhost:1313

Feel free to add to the to-do list, or even better a to-do and solution :)

cc @paperdigits

[paperdigits]

• Have solutions for all pelican plugins
  • article_metadate - hugo does this by default
  • attach_lede_image - hugo does this by default
  • image_compare - probably need a shortcode
  • image_links - allow @![]() as images which are turned into a scaled down preview image and a link to the original file - not sure we need to do anything but change them to regular images.
  • (Mica)render_math - mathjax - https://5fdf51e92c063cb18114dfa4--darktable.netlify.app/2012/09/edge-aware-image-development/
  • rm_nbsp_title - ?
  • social_media - automatically post to twitter. not sure we need to handle this
  • static_comments - handled in hugo templates
  • summary - provides the "Read more..." - handled in hugo templates
  • tipue_search
• (Mica) Search has both a link and an input box
• (Mica) Need RSS links in the footer to match current site
• Can we name the feeds? We'll need to forward at the web server probably.
• Install page: section images for distros don't work
• static comments should check for the existence of the metadata or else don't run the template

[paperdigits]

I've spent about the last 2 hours looking over this with the current site and your port side by side, and damn, this is impressive.

[paperdigits]

hey @robbymilo what's happening? 👯

[robbymilo]

@paperdigits hoping to find some time to work on this soon.

[robbymilo]

Here is a preview for the image_compare replacement (I think this is the only page with a compare?): https://hugo-robbymilo--darktable.netlify.app/2017/11/local-laplacian-pyramids/

[paperdigits]

@robbymilo I'm stupid, but I pushed a few commits to https://github.com/darktable-org/dtorg/tree/robbymilo-robbymilo/hugo

Is the option enabled in github so I can push commits (as a maintainer) to this PR?

[robbymilo]

@paperdigits I added you as a maintainer to https://github.com/robbymilo/dtorg - does that work?

[paperdigits]

Yes, that should work, thanks! On March 22, 2021 11:04:51 AM PDT, Robby Milo ***@***.***> wrote: ***@***.*** I added you as a maintainer to

…

https://github.com/robbymilo/dtorg - does that work? -- You are receiving this because you were mentioned. Reply to this email directly or view it on GitHub: #123 (comment)

[paperdigits]

@robbymilo doh! I didn't accept the invitation soon enough... would you be kind enough to send me another?

[robbymilo]

@paperdigits sent!

[paperdigits]

I think as far as the hugo stuff goes, we're almost done.

Last thing is: handle posts with different slugs - I'd want to use the alias feature from hugo.

Then we just need to look at pages/posts to ensure the markdown rendering looks good. And run a link checker. The last few things we'll need to do with the webserver, like redirecting the RSS feeds.

[patdavid]

This is impressive work, indeed! I can't thank you enough @robbymilo for all of this work! 😄

I just pulled the site and things look really great locally with Hugo.
I know that @paperdigits wanted to check URL's to make sure all the slugs either matched or take advantage of Hugo redirection for ones that do not. Does anyone have a good command we can use to generate a recursive list of all URLs for the site? something something wget something recursive something?

[robbymilo]

@patdavid I think you can range through .Site.AllPages to get every page's .RelPermalink.

[patdavid]

@robbymilo I was thinking of the existing site first, actually. I wanted to get all releveant URL's from the existing site to make sure there was a corresponding match in your port (and if there wasn't, to include a redirect frontmatter so hugo can redirect any old links to the correct slug/location).

[robbymilo]

@patdavid I've added a command (https://github.com/robbymilo/dtorg/blob/robbymilo/hugo/Makefile#L39) that takes all the .html files from the output folder of the current site, and then lists them in https://github.com/robbymilo/dtorg/blob/robbymilo/hugo/output.csv.

Note you need to run the command in the main repo, not my fork.

[paperdigits]

I think this is done. @patdavid can you think of anything else? If you or @robbymilo wants to make a last sanity check, please do!

[elstoc]

still needs to incorporate changes from #141 and #142

[patdavid]

Can we cherry pick those into the hugo branch?

[paperdigits]

@robbymilo I rebased this on master and resolved the conflicts, if you want to take a look at https://github.com/darktable-org/dtorg/tree/hugo

I couldn't figure out how to push that to this PR, and probably better I didn't since it rewrites history.

[elstoc]

@paperdigits the 3.6 blog post needs {filename} removing from the image links in the Hugo port. Same issue in the 3.4 blog post too. I think perhaps we just used html in the previous ones.

Edit: I've pushed a fix for this to the hugo branch now