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

Need to add sitemap.xml support #1979

Closed
Aaronontheweb opened this issue Aug 18, 2017 · 3 comments
Closed

Need to add sitemap.xml support #1979

Aaronontheweb opened this issue Aug 18, 2017 · 3 comments

Comments

@Aaronontheweb
Copy link

@Aaronontheweb Aaronontheweb commented Aug 18, 2017

DocFX Version Used: any

Template used: default

DocFx should really support the ability to produce an XML sitemap; we recently migrated to DocFx on getakka.net and Google is picking up none of our URLs and links.

@vicancy
Copy link
Contributor

@vicancy vicancy commented Sep 19, 2017

According to https://www.sitemaps.org/protocol.html, This URL for loc must begin with the protocol (such as http). Need to provide the host name when docfx build for generating sitemap.xml

@vicancy
Copy link
Contributor

@vicancy vicancy commented Sep 27, 2017

This feature will release in v2.25.
To enable this feature, in "build" section of "docfx.json", at least specify the following:

"sitemap": {
  "baseUrl": "https://yourhostname.com/"
}

To customize more properties, follow https://github.com/dotnet/docfx/blob/dev/Documentation/tutorial/docfx.exe_user_manual.md#324-sitemapoptions

@vicancy vicancy added this to the v2.25 milestone Sep 27, 2017
@vicancy vicancy closed this Oct 10, 2017
@Aaronontheweb
Copy link
Author

@Aaronontheweb Aaronontheweb commented Jun 26, 2018

@vicancy I never followed up on this, but thank you for adding this feature! I really appreciate it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.