jekyll / github-metadata

Jekyll plugin to propagate the `site.github` namespace and set default values for use with GitHub Pages.

Home Page:https://jekyll.github.io/github-metadata/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Add option to configure branch for github_edit_link

runphp opened this issue · comments

commented

The github_edit_link tag currently generates edit links that point to the gh-pages branch by default. This is not ideal when using other default branches like main.
It would be helpful to have an option to configure the target branch for github_edit_link, so it can work properly for repositories using non-gh-pages default branches.

Proposal
Add a configuration option such as github_edit_branch to _config.yml:
yaml
github_edit_branch: main
This will make github_edit_link generate links pointing to that branch.
The user can then set this to main, master or other branches as needed.
This will provide more flexibility when using github_edit_link for repositories with different branch setups.

Benefits

  • Works for non-gh-pages default branch
  • Easy configuration in _config.yml
  • More flexibility for users
  • Links point to correct branch for editing

Please consider adding this option in a future release. Let me know if any clarification is needed!