Skip to content

Add a project.git_default_branch option#32

Closed
no92 wants to merge 3 commits into
hdoc:masterfrom
no92:git_default_branch
Closed

Add a project.git_default_branch option#32
no92 wants to merge 3 commits into
hdoc:masterfrom
no92:git_default_branch

Conversation

@no92

@no92 no92 commented Oct 19, 2022

Copy link
Copy Markdown

This allows for specifying the repository base URL separately from the branch/commit/tag part, which fixes the Repository link in the sidebar while preserving the functionality of the links to declarations, all while being more user-friendly IMO.

The configuration in .hdoc.toml would look like this:

git_repo_url = "https://github.com/hdoc/hdoc/"
git_default_branch = "master"

@hdoc

hdoc commented Oct 19, 2022

Copy link
Copy Markdown
Owner

Thank you. If I recall correctly the "Repository" link used to work even with the blob/main appended to the end of that URL but that seems to have broken in the meantime. In any case, this is an elegant solution for that problem. Thank you for updating the docs as well.

We already have your CAA on file so we will be merging this in to the next release. Your contribution is greatly appreciated.

@hdoc hdoc closed this Oct 19, 2022
@hdoc

hdoc commented Oct 25, 2022

Copy link
Copy Markdown
Owner

Hello @no92, your PR was merged as part of hdoc 1.4.0 which we just released. We have credited you in the release notes, which can be found here: https://hdoc.io/release-notes/#version-1-4-0-24-october-2022. Thank you for your help and for the high quality PR.

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.

2 participants