DemaConsulting.ApiMark.MSBuild 0.1.2

Prefix Reserved

There is a newer version of this package available.
See the version list below for details.

dotnet add package DemaConsulting.ApiMark.MSBuild --version 0.1.2

NuGet\Install-Package DemaConsulting.ApiMark.MSBuild -Version 0.1.2

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="DemaConsulting.ApiMark.MSBuild" Version="0.1.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="DemaConsulting.ApiMark.MSBuild" Version="0.1.2" />
                    

                            Directory.Packages.props

<PackageReference Include="DemaConsulting.ApiMark.MSBuild" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add DemaConsulting.ApiMark.MSBuild --version 0.1.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: DemaConsulting.ApiMark.MSBuild, 0.1.2"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package DemaConsulting.ApiMark.MSBuild@0.1.2

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=DemaConsulting.ApiMark.MSBuild&version=0.1.2
                    

                            Install as a Cake Addin

#tool nuget:?package=DemaConsulting.ApiMark.MSBuild&version=0.1.2
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

ApiMark

Overview

ApiMark generates compact, AI-friendly API reference documentation in Markdown from source code and associated metadata (XML doc comments, header files, docstrings, etc.). The output is designed for gradual disclosure: an AI can read a lightweight index, drill into a namespace summary, and then read a full type page — consuming only as much context as the task requires.

Features

Generates compact Markdown API reference from XML doc comments and source code
Gradual disclosure output: root index → namespace summary → full type page
C#/.NET support via Mono.Cecil and XML documentation comments
MSBuild task integration for .csproj-based builds
dotnet tool CLI (apimark) covering all supported languages
Designed for AI consumption — minimal noise, explicit navigation links between levels

Installation

CLI Tool

dotnet tool install --global DemaConsulting.ApiMark.Tool

MSBuild Integration

Add the NuGet package to your .csproj:

<ItemGroup>
  <PackageReference Include="DemaConsulting.ApiMark.MSBuild" Version="x.y.z" />
</ItemGroup>

Enable XML documentation generation so ApiMark can read doc comments:

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

ApiMark generates documentation automatically after every dotnet build.

Usage

CLI Usage

# Generate API documentation from a .NET assembly
apimark dotnet --assembly MyProject.dll --xml-doc MyProject.xml --output docs/api

Run apimark --help for all options. Run apimark dotnet --help for .NET-specific options.

MSBuild Usage

Documentation is generated automatically after dotnet build. Output goes to $(MSBuildProjectDirectory)\api by default. Configure with MSBuild properties:

<PropertyGroup>
  
  <ApiMarkOutputDir>$(MSBuildProjectDirectory)\docs\api</ApiMarkOutputDir>

  
  <ApiMarkVisibility>PublicAndProtected</ApiMarkVisibility>

  
  <ApiMarkPackDocs>true</ApiMarkPackDocs>

  
  <DisableApiMark>true</DisableApiMark>
</PropertyGroup>

Building

pwsh ./build.ps1

User Guide

The ApiMark User Guide is available on the ApiMark releases page.

Contributing

See CONTRIBUTING.md for guidelines.

License

This project is licensed under the MIT License — see LICENSE.

Support

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- Microsoft.Build.Framework (>= 17.8.43)
- Microsoft.Build.Utilities.Core (>= 17.8.43)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
0.4.8	82	6/24/2026
0.4.7	219	6/19/2026
0.4.6	226	6/18/2026
0.4.5	101	6/18/2026
0.4.4	102	6/18/2026
0.4.3	102	6/17/2026
0.4.2	396	6/16/2026
0.4.1	100	6/15/2026
0.4.0	133	6/15/2026
0.3.2	97	6/9/2026
0.3.1	87	6/9/2026
0.3.0	133	6/9/2026
0.2.0	142	6/8/2026
0.1.3	213	6/1/2026
0.1.2	101	6/1/2026
0.1.1	104	6/1/2026
0.1.0	112	6/1/2026