Github View/Edit links broken if defaultContentLanguageInSubdir = false

[fekete-robert]

Hi, I am working on a site that uses Docsy 0.6.0 and might have hit a bug related to the following settings:

contentDir = "content"
defaultContentLanguage = "en"
defaultContentLanguageInSubdir = false

The site is only available in English, so we don't use the content/en/ subdir. The site builds fine, but the github links "View/edit this page" are broken, because they do contain the "/en/" part.

I wanted to create a PR to omit the language from https://github.com/google/docsy/blob/main/layouts/partials/page-meta-links.html if "defaultContentLanguageInSubdir = false", but since this parameter is not under the [params] tag of the config file, it's not accessible from the partial (unless I'm missing something).

Does anyone have a solution or workaround to the problem? It's not a big issue, if there is no neat solution I'll just hide the links. An ugly workaround would be to duplicate the "defaultContentLanguageInSubdir = false" under [params] as well, but that's a really ugly hack.

The site is https://kube-logging.github.io/docs/ , its source is available at https://github.com/kube-logging/kube-logging.github.io/blob/master/config/_default/config.toml

Thanks!
Robert

[chalin]

I have a similar setup for another project, and there are no issues with the GH page links. I'll investigate further and get back to you soon (probably later today).

[chalin]

I haven't double checked yet, but off the top of my head what I recall is that you'll need to replace the contentDir by a mount point because we're not supposed to mix mount points (which are required when using Hugo modules) with the old *Dir config parameters.

From https://gohugo.io/hugo-modules/configuration/#module-config-mounts (emphasis mine):

When the mounts config was introduced in Hugo 0.56.0, we were careful to preserve the existing contentDir, staticDir, and similar configuration to make sure all existing sites just continued to work. But you should not have both: if you add a mounts section you should remove the old contentDir, staticDir, etc. settings.

Let me know if this helps.

[fekete-robert]

We don't use module mounts for this project, so it's not mixed. I've played around them a bit but didn't seem to solve the issue. I'll override the partial locally in our project to fix the links for now.

[LisaFC]

It would be great if @chalin's workaround works because this is an old, old problem - as you discovered, you can't actually find defaultContentLanguageInSubdir via params in the partial, so there have been a variety of hacky solutions from various Docsy users, including overriding the entire partial.

[fekete-robert]

@LisaFC I couldn't get it work, but I have found another one that might be good enough to create an "official" workaround.

You can access the defaultContentLanguage = "en" and defaultContentLanguageInSubdir = false config parameters from the partials if you set them to cascade in the config file, like this:

[cascade]
defaultContentLanguage = "en"
defaultContentLanguageInSubdir = false

If this is set in the config file, then something like this works in the partial (I don't manage multilanguage sites so I don't know what the proper conditions would be):

{{ if and (eq ($.Param "defaultContentLanguage") (.Site.Language.Lang)) ($.Param "defaultContentLanguageInSubdir") -}}
    <!-- If defaultContentLanguageInSubdir is true and defaultContentLanguage is the current language -->
    {{ $gh_repo_path = printf "%s/content/%s/%s" $gh_branch ($.Site.Language.Lang) $pathFormatted -}}
    {{ else if and (eq ($.Param "defaultContentLanguage") (.Site.Language.Lang)) (not ($.Param "defaultContentLanguageInSubdir")) -}}
    <!-- If defaultContentLanguageInSubdir is false and defaultContentLanguage is the current language -->
    {{ $gh_repo_path = printf "%s/content/%s" $gh_branch $pathFormatted -}}

What do you think?

[chalin]

Nice site you have there!

We don't use module mounts for this project, so it's not mixed

If you're using Docsy, since Docsy uses mounts, then your project is using mounts too 🤷‍♂️:

docsy/config.yaml

Lines 24 to 46 in 5597d43

	mounts:
	- source: assets
	target: assets
	- source: node_modules/bootstrap
	target: assets/vendor/bootstrap
	- source: node_modules/@fortawesome/fontawesome-free
	target: assets/vendor/Font-Awesome
	- source: i18n
	target: i18n
	- source: layouts
	target: layouts
	- source: static
	target: static
	- source: node_modules/@fortawesome/fontawesome-free/webfonts
	target: static/webfonts
	# Mounts for projects using Docsy as an NPM package. The source path prefix
	# "../.." moves out of themes/docsy so that Docsy can find its dependencies.
	- source: ../../node_modules/bootstrap
	target: assets/vendor/bootstrap
	- source: ../../node_modules/@fortawesome/fontawesome-free
	target: assets/vendor/Font-Awesome
	- source: ../../node_modules/@fortawesome/fontawesome-free/webfonts
	target: static/webfonts

I've played around them a bit but didn't seem to solve the issue.

Ok. I'll take a look as soon as I can (quite busy atm). I'm starting to feel that this is a bug in the page-link rendering.

In the meantime, you should be able to use the path_base_for_github_subdir feature (with from and to fields) to get around the bug (to remove the /en from link paths).

[chalin]

FYI, I just checked my other projects, and they all have their docs under content/en even though they don't have any other languages at the moment. So, that might also be a simple solution for you 🤷.

[bdalpe]

I was able to use the workaround provided by @chalin. Sample toml config:

[params.path_base_for_github_subdir]
# change content/<lang>/... to content/...
from = "content/(.*?)/(.*?)"
to = "content/$2"

[chalin]

@fekete-robert - can you confirm whether the following would have fixed the issue?

• Fix links for single language sites #1744

[fekete-robert]

Yes, it seems to work. Thanks!

[chalin]

#1744 is the main fix in 0.9.0.
Thanks for confirming that it is working now for you.

Closed by #1744