dotnet / dotnet/docfx

How do I specify baseUrl for the hrefs generated in xrefmap?

Open
#5,258 0 comments 6 reactions 0 assignees View on GitHub
xref
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

Is there a way to specify the `baseUrl` to be used when generating the `xrefmap.yml` file?

So that it generates

` href: http://[baseurl]/api/[ProjectName]/[UniqueId].html`

instead of

` href: api/[ProjectName]/[UniqueId].html`

-----------------------------------------------------------

Or else, it would be also helpful if it was possible to simply define the `baseUrl` in the `docfx.json`

"xref": [
{
"fileName": "xrefmap/xrefmap.yml",
"baseUrl": "http://baseurl/"
}
]

------------------------------------------------------------

The reason behind this is that, I don't want to manually modify the `xrefmap.yml` file generated by another project.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.