AistDoc is an API documentation generator and publishing tool for your code. Currently it supports:

• .NET with XML documentation comments
• TypeScript with code comments in TSDoc format (a superset of JSDoc).

Main AistDoc features:

1. It collects all information about your code: the list of namespaces, structures, interfaces, enums, and classes as well as methods and properties of the classes and interfaces.

2. It generates Markdown (or HTML) files which represent the full reference of your API (one file for each class, interface or enum). If your code contains XML documentation (for .NET projects) or TSDoc (for TypeScript) comments - then those comments will be added to the generated articles as well.
   NB1: For TypeScript projects, you will also need to process your code with TypeDoc tool first.
   NB2: Here you can find the detailed description of TSDoc comments format.

3. It publishes the documentation generated on step #2 on the Web using Aistant service as a hosting platform.

As a result, you will get a nice website with full API reference of your code. Since Aistant is a general-purpose service for managing knowledge bases and help centers - you can add to that documentation your own articles with basic concepts of your project, tutorials, code samples, etc .

Aistdoc is implemented as a .NET Core Global Tool, so its installation is quite simple:

dotnet tool install -g Aistant.DocImport

To update it to the latest version, if it was installed previously, use:

dotnet tool update -g Aistant.DocImport

NB: Of course you need .NET Core SDK (version 2.1 or higher) be installed on your computer (Linux, Windows or Mac) first.

For details on how to publish your documentation please read one of our tutorials:

• Publishing the API reference for your .NET code

• Publishing the API reference for your TypeScript project with TSDoc