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

WIP: Use Hugo modules #2

Closed
wants to merge 2 commits into from
Closed

WIP: Use Hugo modules #2

wants to merge 2 commits into from

Conversation

LorenzBischof
Copy link
Contributor

@LorenzBischof LorenzBischof commented Feb 18, 2022

The following PRs have added Hugo Modules support to Docsy:
google/docsy#871
google/docsy#802

I would wait until v0.2.0 is released.

To use the the docsy-plus module the following can be added into the config:

theme = ["github.com/acend/docsy-plus"]

It might even make sense to have docsy-puzzle and docsy-acend manage the docsy-plus theme.

See https://gohugo.io/hugo-modules/use-modules/ for more information on how to use Hugo Modules.

I had some problems with Module versions. The required module versions from https://github.com/google/docsy/blob/master/go.mod must be added to go.mod within this repository. Running hugo mod tidy should add these automatically.

@splattner
Copy link
Member

is this PR still needed? @phil-pona

@LorenzBischof
Copy link
Contributor Author

It depends if you would like to use Hugo Modules instead of Git Submodules. Docsy now recommends using Hugo Modules, but still supports Git Submodules.

This was left WIP because the Docsy version supporting Hugo Modules was not released yet. Since the README now contains references to Hugo Modules, I guess you could use it now.

@phil-pona
Copy link
Member

The PR needs to be adjusted though, the font and boostrap deps are part of the github.com/google/docsy/dependencies
Currently all Trainings Repos use Go Hugo modules instead of Git Submodules already.

I'm going to try to implement this one today. After that we can finally rearrange the deps so that the docsy and docsy dependencies are deps from the docsy plus instead of the actual Training module, which will make updating those dependencies a lot easier and more straightforward

@phil-pona
Copy link
Member

implemented with #13

@phil-pona phil-pona closed this Aug 3, 2022
@phil-pona phil-pona deleted the go-module branch August 3, 2022 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants