Example for `code-links` in Manuscript

[mcanouil]

What would you like to do?

Give feedback or suggest an improvement

Description

From Hadley:

I found it very hard to figure out how to add a github repo link following the advice at https://quarto.org/docs/manuscripts/components.html#github-and-binder-links.
It would be nice to have an example (i.e. all you need is code-links: repo)

[m-jenkin]

Seconded! I cant figure out how to add the repo - link fails.

[mcanouil]

@m-jenkin No need to comment, simply add a reaction to the original post. 😉 (Reactions don't trigger notifications to all subscribers but are still visible)
This is true on all GitHub.
Issues can be sorted based on reactions which is a more accurate proxy of the interest than sorting based on total comments (which can be about anything and everything, not only "+1").

[Selbosh]

The latest commit marks this as closed but the documentation is still very confusing and does not solve the issue in my opinion. How does the project know where the GitHub repository is? If it infers it from a .git file in the project folder, the documentation should say this. If there is a way of specifying the GitHub repository manually via YAML, it should also say this.

WARN: The 'repo' code link is not able to be created as the project isn't a GitHub project.
ERROR: Unknown code-link value 'repo'

[cwickham]

@Selbosh, I've added the following (in quarto-dev/quarto-web#1608):

Quarto infers the URL for the link from the Git settings of your manuscript project.
For code-links: repo to work, your manuscript project should be a Git repository,
and have GitHub as the remote origin.

There is no way to specify the GitHub repo via YAML.

[Selbosh]

Thanks, much appreciated!