Summary 0.0.4-dev202312071910

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of Summary.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package Summary --version 0.0.4-dev202312071910                

                    
                

            
NuGet\Install-Package Summary -Version 0.0.4-dev202312071910
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="Summary" Version="0.0.4-dev202312071910" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Summary --version 0.0.4-dev202312071910                

                    
                

            
#r "nuget: Summary, 0.0.4-dev202312071910"
#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. 
// Install Summary as a Cake Addin
#addin nuget:?package=Summary&version=0.0.4-dev202312071910&prerelease

// Install Summary as a Cake Tool
#tool nuget:?package=Summary&version=0.0.4-dev202312071910&prerelease

<div align="center"> <img src="./res/icon-512.png" alt="Logo" width="128" height="128"></img> </div>

<h1 align="center"><summary></h1>

<p align="center"> <i>Flexible and effortless API reference generator for .NET.</i> </p>

<p align="center"> <img alt="Nuget" src="https://img.shields.io/nuget/v/Summary"> </p>

Usage

Currently, the generator is pretty young. In order to use it, you should download Summary (Core), Summary.Roslyn (Parser) and Summary.Markdown (Renderer) packages.

Here is a simple code-snippet that parses files in the specified directory and renders them into Markdown format:

// The folder you want to parse the `*.cs` files from.
const string input = "./src";

// The folder you want to put the generator output into.
const string output = "./docs";

await new SummaryPipeline()
    .UseRoslynParser(input)
    .UseMdRenderer(output)
    .UseDefaultFilters()
    .Run();

Examples

Consider checking out the docs directory: it's the Summary summary generated by Summary. 🌞

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Summary:

Package Downloads
Summary.Markdown

Markdown plugin for Summary documentation generator.
Summary.Roslyn

Plugin for Summary documentation generator that parses documentation using Roslyn API.

GitHub repositories

This package is not used by any popular GitHub repositories.