CODEWITHSUNDEEP
githubdocumentation.net-8.0sandcastle
Alek Davis
Alek Davis

Reputation: 10752

How to incorporate XML comment-based API documentation into GitHub?

If I have a public GitHub repo hosting .NET Core libraries, is there an easy way to integrate the documentation from the XML comments in GitHub?

I use SandCastle Help File Builder and in the past, I would just build a CHM file that would accompany a DLL, but I suspect CHM files would be useless on Linux and Mac platforms. A logical place to share the API documentation would be the project repo on GitHub, but I do not want to duplicate the information that I already created via XML comments and SandCastle topic files.

I tried generating different help formats (Open XML, web site, .MD file), but when checking them into the repo, they just show as source code (i.e. they cannot be used as hypertext documents with clickable links).

Is there a better way for reusing XML comment-based documentation from the project on GitHub?

Upvotes: 0

Views: 17

Answers (0)

Related Questions