This is not the latest version of DocFX available.

2.18.2 | Updated: 01 Jun 2017



Downloads of v 2.18.2:


Software Author(s):

  • Microsoft

DocFX 2.18.2

This is not the latest version of DocFX available.

All Checks are Passing

2 Passing Test

Validation Testing Passed

Verification Testing Passed


To install DocFX, run the following command from the command line or from PowerShell:


To upgrade DocFX, run the following command from the command line or from PowerShell:


To uninstall DocFX, run the following command from the command line or from PowerShell:


NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Enter your internal repository url

(this should look similar to

4. Choose your deployment method:

choco upgrade docfx -y --source="'STEP 3 URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:

choco upgrade docfx -y --source="'STEP 3 URL'"

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0

Exit $exitCode

- name: Ensure docfx installed
    name: docfx
    state: present
    version: 2.18.2
    source: STEP 3 URL

See docs at

Coming early 2020! Central Managment Reporting available now! More information...

chocolatey_package 'docfx' do
  action    :install
  version  '2.18.2'
  source   'STEP 3 URL'

See docs at

    Name: docfx,
    Version: 2.18.2,
    Source: STEP 3 URL

Requires Otter Chocolatey Extension. See docs at

cChocoPackageInstaller docfx
   Name     = 'docfx'
   Ensure   = 'Present'
   Version  = '2.18.2'
   Source   = 'STEP 3 URL'

Requires cChoco DSC Resource. See docs at

package { 'docfx':
  provider => 'chocolatey',
  ensure   => '2.18.2',
  source   => 'STEP 3 URL',

Requires Puppet Chocolatey Provider module. See docs at

salt '*' chocolatey.install docfx version="2.18.2" source="STEP 3 URL"

See docs at

5. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

Private CDN cached downloads available for licensed customers. Never experience 404 breakages again! Learn more...

This package was approved as a trusted package on 01 Jun 2017.


DocFx is a documentation generation tool for api reference and markdown files!

DocFX is an API documentation generator for .NET, currently supporting C# and VB, as similar to JSDoc or Sphinx. It has the ability to extract triple slash comments out from your source code. What's more, it has syntax to link additional files to API to add additional remarks. docfx will scan your source code and your additional conceptual files and generate a complete HTML documentation website for you. docfx provides the flexibility for you to customize the website through templates. We currently have several embedded templates, including websites containing pure static html pages and also website managed by AngularJS. Of cause, if you are interested in creating your own website with your own styles, you can follow how to create custom template to create custom templates to create custom templates.


  • Generate API Documentation - Able to generate API documentation from triple-slash-comments for .NET source code directly!
  • Generate Conceptual Documentation - Able to generate HTML from markdown files supporting DFM syntax.
  • Easy Customization - Able to customize templates and themes easily

$ErrorActionPreference = 'Stop';

$packageName= 'DocFX'
$version    = 'v2.18.2'
$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
$url        = "$version/"
$sha1       = '7a35a4aa709e97cbd57388c9ab5572e995d01d01'

$packageArgs = @{
  packageName   = $packageName
  unzipLocation = $toolsDir
  url           = $url
  checksum      = $sha1
  checksumType  = 'sha1'

Install-ChocolateyZipPackage @packageArgs

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Version Downloads Last Updated Status
DocFX 2.56.1 3954 Monday, July 6, 2020 Approved
DocFX 2.56 983 Monday, June 29, 2020 Approved
DocFX 2.55 3214 Friday, June 12, 2020 Approved
DocFX 2.54 3339 Monday, May 25, 2020 Approved
DocFX 2.53.1 2378 Monday, May 11, 2020 Approved
DocFX 2.53 106 Monday, May 11, 2020 Approved
DocFX 2.52 6303 Saturday, April 11, 2020 Approved
DocFX 2.51 3774 Friday, March 20, 2020 Approved
DocFX 2.50 3343 Monday, March 2, 2020 Approved

This package has no dependencies.

Discussion for the DocFX Package

Ground Rules:

  • This discussion is only about DocFX and the DocFX package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or DocFX, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus