Nacara.ApiGen is in early beta.
It can already be used to produce API documentation, but changes in the generated files are expected in future version and it is possible that not every F# types are supported yet.
Nacara.ApiGen is a tool for generating API documentation from your code.
nacara-layout-standard is the package providing the standard layout when working with Nacara.
dotnet new tool-manifest # if you are setting up this repo dotnet tool install Nacara.ApiGen
nacara-apigen generateds markdonw files that can be consume by
nacara to generate the
# First prepare the DLLs and XML files dotnet publish # Run nacara-apigen dotnet nacara-apigen \ --project MyProject \ -lib src/bin/Debug/netstandard2.0/publish \ --output docs \ --base-url /my-site/
nacara-apigen doesn't know yet how to read your
nacara.config.json so you need to pass everything via CLI arguments:
-p: The name of your project
-lib: The source dierectory where your dlls and xml files are located
--base-url: Base URL for your site. The same as you configured in your
-o: The output directory
In order to works,
nacara-apigen needs to have access to all your project dlls and xml files., the easiest way to get them is to run
dotnet publish before invoking
dotnet nacara-apigen using the generated directory as source.
Control the color of the keywords.
Control the color of the types.