Loic.dotnet.docfx 1.0.0

.NET 5.0

dotnet add package Loic.dotnet.docfx --version 1.0.0

NuGet\Install-Package Loic.dotnet.docfx -Version 1.0.0

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="Loic.dotnet.docfx" Version="1.0.0" />

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

<PackageVersion Include="Loic.dotnet.docfx" Version="1.0.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Loic.dotnet.docfx" />
                    

                            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 Loic.dotnet.docfx --version 1.0.0

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

#r "nuget: Loic.dotnet.docfx, 1.0.0"

#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 Loic.dotnet.docfx@1.0.0

#: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=Loic.dotnet.docfx&version=1.0.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Loic.dotnet.docfx&version=1.0.0
                    

                            Install as a Cake Tool

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

Generate your documentation with DocFX

DocFX makes it extremely easy to generate your developer hub with a landing page, API reference, and conceptual documentation, from a variety of sources.

Quickstart

Install DocFX and deploy a sample documentation web site:

Open a console.
Enter the following commands to install DocFX and build/deploy a sample site:
```
choco install docfx
docfx init -q
docfx docfx_project\docfx.json --serve
```
Go to https://localhost:8080 to view the sample DocFX site.

For more information, refer to Getting Started.

DocFX project

Build the DocFX solution

To build the DocFX binaries from the Visual Studio solution:

Install Visual Studio 2019 with .NET Core cross-platform development toolset
Install Node.js
Build the solution using one of the following options:
- Option 1: Console
  - Open a DOS console and navigate to your DocFX clone subdirectory.
  - Run build.cmd.
- Option 2: Visual Studio
  - Open a PowerShell console and navigate to your DocFX clone subdirectory.
  - Run ./UpdateTemplate.ps1 to generate the template files required by the Visual Studio solution.
  - Open the docfx.sln solution in your DocFX clone subdirectory from Visual Studio and build it.

Build Status

dev is the default branch accepting Pull Requests. It releases a package daily. main branch is the release branch.

main	dev

Install packages

Chocolatey	Nuget

Running Status

Windows with VS2017	Ubuntu Linux with Mono

How to Contribute

For new comers, you can start with issues with help-wanted. Check out the contributing page to see the best places to log issues and start discussions.

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

License

DocFX is licensed under the MIT license.

DocFX is supported by the .NET Foundation.

Product	Compatible and additional computed target framework versions.
.NET	net5.0 is compatible. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net5.0
- No dependencies.

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
1.0.0	0	7/31/2021