allow repository links to be provided through a data file #492
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds support for supplying repository links via a Hugo data file next to the builtin GitHub support. The idea is to enable more complex workflows by separating out the task of generating the links and leaving it to the user:
support literate programming workflows: tools like Rmarkdown can be easily chained with Hugo in a CI system by writing dynamically generated markdown in the content directory of Hugo. However in this case the true source is different than the one seen by Hugo so the Docsy links will point to the wrong files.
support multi-repository sites. In large projects it may be desirable to distribute the site sources over multiple repositories e.g. for access control reasons but still aggregate everything to a single site (e.g. with git submodules which break the links)
By using Hugo data files YAML, JSON and TOML are all supported.
TOML example:
As a bonus, this also provides an escape hatch for non-GitHub hosted repositories. The documentation states:
this PR provides an alternative approach by allowing users to generate the links for whatever git server in CI