[en] Online API reference

Topics: Technical Support
Coordinator
Nov 2, 2012 at 1:23 AM
Edited Nov 3, 2012 at 10:33 PM

Documentation is generated using Sandcastle Help File Builder: http://shfb.codeplex.com/

Coordinator
Nov 4, 2012 at 6:01 PM

Thanks for hosting Zyan API reference. I prefer the sandcastle version with C# syntax. But I hope apistack.net will support C# syntax in future, because the site has a really nice UI.

Coordinator
Nov 23, 2012 at 8:46 PM
Edited Nov 23, 2012 at 8:52 PM

I finally gave up fighting with Sandcastle javascripts... I didn't managed to fix them so the documentation looks the same in all browsers. Also, I wasn't able to display Sandcastle help hosted on GitHub pages in Internet Explorer for some reason. The frame simply didn't resize to the full window's width. I tried my best to investigate it, but it's beyond my abilities as I'm not an expert in modern web programming.

So I fell back to using ImmDoc.NET. I forked the project and fixed the bugs that stopped me from using it (wrong namespace order in TOC and crash on public nested classes). Everything works well now and API reference looks almost the same in Chrome and IE8/9. Here is an updated version:

http://yallie.github.com/zyan/docs/v24/

The good thing is that ImmDocNet is tiny (I easily figured out how to hack it) and runs at least 20 times as fast as Sandcastle. The generated files are much smaller. I think it's not that hard to tweak the output templates (in particular, CSS), to make it look more MSDN-like.

BTW, I really liked GitHub pages hosting. Version control for the website is a definitely great thing.