Update Available: Click here to download the latest {{ projectName }} API documentation for offline usage

How to run NuDoq locally

NuDoq requires a local website to run. Running directly from the file system is not supported currently.

The most convenient way to run a local website from a folder is to use IIS Express.

If you have a folder %ProgramFiles%\IIS Express on your machine, you already have it (it comes bundled with Visual Studio 2010 or greater). You can also upgrade to the latest version.

Once you have it installed, just run this command to start a local website:

"%ProgramFiles%\IIS Express\iisexpress.exe" /path:"YOUR_FOLDER_HERE" /port:YOUR_PORT_HERE
And you're ready to navigate to the resulting http://localhost:PORT address and open this local NuDoq site again.


Alternatively, you can rename the file run.bat.rename to run.bat alongside the index.html file, and use that instead. It will choose a random port from 10000 to 20000 and start IIS Express.Updated

What is NuDoq?

TL;DR

  • Fast indexing and quick search (tree views are so 90's!)
  • Community involvement via discussions and wiki-style content contributions
  • Automatically updated from NuGet.org packages (ALL of them!)
  • Automatic grouping of packages by project and cross linking
  • Offline support: just download a zip file!

NuDoq provides the missing link between straightforward access and updates to NuGet packages, and their corresponding API documentation. If you're familiar with tools like Sandcastle and NDoc, they were built for an entirely different era: that of static documentation, with no community involvement, no peer-to-peer support, no frequently updated packages!

With all of the new shiny technologies available at our disposal, why limit ourselves to 90's looking documentation sites, with no built-in search or filter, with endless tree views that take forever to navigate, and so on?

In short, NuDoq is:

 Socialized API documentation for the XXI century

Community

We know how much better community-driven content can be, compared to the official documentation on pretty much every open source project. The rich discussions among actual users of a feature, their tips and tricks, and innovative usage of a library. All of that is sometimes even more important than the actual API documentation itself.

NuDoq embraces the community by including a Disqus thread for every page of content (i.e. project landing page, package, assembly, namespace and all public members), as well as a wiki-style section of content that can be edited by anyone with a GitHub account.

Feedback

We want to make NuDoq the best API documentation platform ever and we value immensely your feedback on how to make it better. We'd love to hear your ideas, bugs or comments on our feedback forums .

If you want to leverage the platform for your own privately hosted NuGet feeds, contact us.

Why NuGet?

NuGet is quickly becoming the de-facto distribution mechanism for libraries for all things .NET, and not just for Windows. Even the .NET framework has started to move towards more fine-grained packages that will be delivered via NuGet.org.

So why not leverage the tremendous potential of having centralized repositories of most (eventually all?) packages to build a unified API documentation layer on top?

One of the key benefits of using NuGet to drive the API documentation site is that NuDoq can provide

 Automatically updated API documentation when NuGet packages are published

So now the same XML documentation that's shipped with NuGet packages to drive intellisense tooltips within the IDE, is used to drive a corresponding site, automatically and seamlessly.

How it works

We regularly poll NuGet.org for the latest package updates, unpack and process the library documentation files, and update the site accordingly.

To improve the searching experience, we group packages by project, like Autofac. This allows you to easily and quickly locate the documentation and associated discussions.

If you're a project author and want to tune the way we group your packages or make any other suggestions, feel free to contact us.



Community


Note: content is contributed via GitHub. Make sure you're signed in with your account before editing content. Otherwise, you'll get a 404 error with the option to sign in.


Community

Be the first to edit the community content of this topic

Note: content is contributed via GitHub. Make sure you're signed in with your account before editing content. Otherwise, you'll get a 404 error with the option to sign in.