Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cross-site DocFx site linking #2596

Closed
Aaronontheweb opened this issue Apr 5, 2018 · 2 comments
Closed

Cross-site DocFx site linking #2596

Aaronontheweb opened this issue Apr 5, 2018 · 2 comments

Comments

@Aaronontheweb
Copy link

This is more of a capabilities question than anything else.

I love DocFx and use it on several major projects, most of which are open source. Suppose I do the following:

  1. Ship open source library A and publish documentation for it at a.foo.com
  2. Ship open source library B, which depends on A, and I publish documentation for it on b.foo.com

Is it possible (or, could it be possible) to have all of my references to library A from within library B automatically link to the correct place on a.foo.com via referencing a remote .yml file or anything else of that sort? This would be quite ace for my team as it would allow us to publish multiple DocFx websites independently but still freely inter-link between them for all of those projects.

@Still34
Copy link

Still34 commented Apr 6, 2018

Ditto. Would like to know.

@vwxyzh
Copy link
Contributor

vwxyzh commented Apr 8, 2018

@Aaronontheweb yes, you can do it.
For example, if you want to reference docfx's API, you just need to add address http://dotnet.github.io/docfx/xrefmap.yml in your xref property.
Document is here.

@herohua herohua closed this as completed Jul 9, 2018
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

No branches or pull requests

4 participants