Skip to content

sakno/fuget-xref

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 

Repository files navigation

XREF Generator for FuGet

This tool allows to generate a file with cross-references for the specific NuGet package available on public feed. This file can be used in DocFX project. As a result, you can use cross-references to API related to your package in the documentation without buggy built-in API documentation generator from DocFX.

Usage:

cd ./src/
dotnet run -c Release -- <PackageName> <PackageVersion> <TargetFramework> <OutputFile>

Example:

cd ./src/
dotnet run -c Release -- DotNext.Reflection 3.0.0 net5.0 DotNext.Reflection.xref

The produced file is in YAML format. It can be added to DocFX JSON configuration for your project as a source of cross-references. Examine this article for more info.

About

A tool for generating XREF map that allows to use FuGet as a source for API documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages