GitHub Autolinks
Auto-links bare issue numbers, cross-repo references, and commit SHAs to GitHub.
The GitHub Autolinks feature turns bare references to GitHub issues, pull requests, and commits into real hyperlinks pointing at a configured repository. Write #123 in prose and it becomes a link to that issue — no manual URL needed.
Note
Enable it with the githubAutolinks key in zfb.config.ts. The repo field is mandatory — the feature stays inactive without it:
/Recognized forms
Three reference forms are auto-linked. zudo-doc configures repo: "zudolab/zudo-doc", so the default repository in the examples below is zudolab/zudo-doc:
| Source (what you type) | Resolves to |
|---|---|
#123 | https: |
owner/repo#123 | https: |
| 40-character commit SHA | https: |
Live demo
Each reference below is plain prose, so the feature transforms it into a link at build time. Hover or click to confirm the target:
Bare issue reference: #456 links to issue 456 in the configured repo.
Cross-repository reference: zudolab/zudo-doc#123 links to issue 123 in that repo.
Commit SHA: 1234567890abcdef1234567890abcdef12345678 links to that commit.
Scope
References inside inline code (
`#123`) or fenced code blocks are not transformed — that is how the syntax in the table above stays literal.Text already wrapped in an anchor tag is left alone, preventing double-linking.
A cross-repository reference uses its own embedded
owner/repo, not the globally configuredrepo.Pure decimal-digit sequences are treated as plain numbers, not commit hashes.