Unpacking Software Livestream

Join our monthly Unpacking Software livestream to hear about the latest news, chat and opinion on packaging, software deployment and lifecycle management!

Learn More

Chocolatey Product Spotlight

Join the Chocolatey Team on our regular monthly stream where we put a spotlight on the most recent Chocolatey product releases. You'll have a chance to have your questions answered in a live Ask Me Anything format.

Learn More

Chocolatey Coding Livestream

Join us for the Chocolatey Coding Livestream, where members of our team dive into the heart of open source development by coding live on various Chocolatey projects. Tune in to witness real-time coding, ask questions, and gain insights into the world of package management. Don't miss this opportunity to engage with our team and contribute to the future of Chocolatey!

Learn More

Calling All Chocolatiers! Whipping Up Windows Automation with Chocolatey Central Management

Webinar from
Wednesday, 17 January 2024

We are delighted to announce the release of Chocolatey Central Management v0.12.0, featuring seamless Deployment Plan creation, time-saving duplications, insightful Group Details, an upgraded Dashboard, bug fixes, user interface polishing, and refined documentation. As an added bonus we'll have members of our Solutions Engineering team on-hand to dive into some interesting ways you can leverage the new features available!

Watch On-Demand
Chocolatey Community Coffee Break

Join the Chocolatey Team as we discuss all things Community, what we do, how you can get involved and answer your Chocolatey questions.

Watch The Replays
Chocolatey and Intune Overview

Webinar Replay from
Wednesday, 30 March 2022

At Chocolatey Software we strive for simple, and teaching others. Let us teach you just how simple it could be to keep your 3rd party applications updated across your devices, all with Intune!

Watch On-Demand
Chocolatey For Business. In Azure. In One Click.

Livestream from
Thursday, 9 June 2022

Join James and Josh to show you how you can get the Chocolatey For Business recommended infrastructure and workflow, created, in Azure, in around 20 minutes.

Watch On-Demand
The Future of Chocolatey CLI

Livestream from
Thursday, 04 August 2022

Join Paul and Gary to hear more about the plans for the Chocolatey CLI in the not so distant future. We'll talk about some cool new features, long term asks from Customers and Community and how you can get involved!

Watch On-Demand
Hacktoberfest Tuesdays 2022

Livestreams from
October 2022

For Hacktoberfest, Chocolatey ran a livestream every Tuesday! Re-watch Cory, James, Gary, and Rain as they share knowledge on how to contribute to open-source projects such as Chocolatey CLI.

Watch On-Demand

DocFX 2.8

This is not the latest version of DocFX available.

Legal Disclaimer: Neither this package nor Chocolatey Software, Inc. are affiliated with or endorsed by Microsoft. The inclusion of Microsoft trademark(s), if any, upon this webpage is solely to identify Microsoft goods or services and not for commercial purposes.

  • 1
  • 2
  • 3

All Checks are Passing

3 Passing Tests


Validation Testing Passed


Verification Testing Passed

Details

Scan Testing Successful:

No detections found in any package files

Details
Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

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:

>

Deployment Method:

NOTE

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

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)


2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

  • 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 https://community.chocolatey.org/api/v2/. 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. Copy Your Script

choco upgrade docfx -y --source="'INTERNAL REPO URL'" --version="'2.8'" [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="'INTERNAL REPO URL'" --version="'2.8'" 
$exitCode = $LASTEXITCODE

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

Exit $exitCode

- name: Install docfx
  win_chocolatey:
    name: docfx
    version: '2.8'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'docfx' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '2.8'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller docfx
{
    Name     = "docfx"
    Version  = "2.8"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'docfx':
  ensure   => '2.8',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

NOTE

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

Package Approved

This package was approved as a trusted package on 22 Nov 2016.

Description

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.

Features

  • 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

tools\chocolateyinstall.ps1
$ErrorActionPreference = 'Stop';

$packageName= 'DocFX'
$version    = 'v2.8'
$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
$url        = "https://github.com/dotnet/docfx/releases/download/$version/docfx.zip"
$sha1       = '4f9e309f3df7f92c3ca4f9f44ce7f9015c0b8f4f'

$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.

Add to Builder Version Downloads Last Updated Status
DocFX 2.59.3 44859 Wednesday, July 6, 2022 Approved
DocFX 2.59.2 23850 Monday, April 11, 2022 Approved
DocFX 2.59.1 2500 Thursday, March 31, 2022 Approved
DocFX 2.59.0 24372 Wednesday, January 19, 2022 Approved
DocFX 2.58.9 17094 Thursday, November 4, 2021 Approved
DocFX 2.58.8 560 Wednesday, November 3, 2021 Approved
DocFX 2.58.5 56688 Tuesday, October 26, 2021 Approved
DocFX 2.58.4 13112 Tuesday, September 14, 2021 Approved
DocFX 2.58.2 5585 Tuesday, August 24, 2021 Approved
DocFX 2.58 26279 Wednesday, June 16, 2021 Approved
DocFX 2.57.2 22529 Tuesday, April 20, 2021 Approved
DocFX 2.57.1 2096 Tuesday, April 13, 2021 Approved
DocFX 2.57 860 Friday, April 9, 2021 Approved
DocFX 2.56.7 15328 Tuesday, March 2, 2021 Approved
DocFX 2.56.6 36923 Thursday, December 10, 2020 Approved
DocFX 2.56.5 7123 Tuesday, November 10, 2020 Approved
DocFX 2.56.4 9155 Tuesday, October 20, 2020 Approved
DocFX 2.56.2 20160 Monday, July 27, 2020 Approved
DocFX 2.56.1 4151 Monday, July 6, 2020 Approved
DocFX 2.56 1187 Monday, June 29, 2020 Approved
DocFX 2.55 4439 Friday, June 12, 2020 Approved
DocFX 2.54 3588 Monday, May 25, 2020 Approved
DocFX 2.53.1 2598 Monday, May 11, 2020 Approved
DocFX 2.53 358 Monday, May 11, 2020 Approved
DocFX 2.52 6552 Saturday, April 11, 2020 Approved
DocFX 2.51 13679 Friday, March 20, 2020 Approved
DocFX 2.50 3503 Monday, March 2, 2020 Approved
DocFX 2.49 50605 Monday, February 17, 2020 Approved
DocFX 2.48.1 10229 Monday, January 6, 2020 Approved
DocFX 2.48 8031 Monday, December 9, 2019 Approved
DocFX 2.47 6517 Tuesday, October 29, 2019 Approved
DocFX 2.46 2401 Saturday, October 12, 2019 Approved
DocFX 2.45.1 6658 Thursday, September 12, 2019 Approved
DocFX 2.45 2776 Friday, August 23, 2019 Approved
DocFX 2.44 3006 Friday, August 2, 2019 Approved
DocFX 2.43.4 223 Friday, August 2, 2019 Approved
DocFX 2.43.3 2763 Monday, July 15, 2019 Approved
DocFX 2.43.2 2355 Monday, June 24, 2019 Approved
DocFX 2.43.1 754 Wednesday, June 19, 2019 Approved
DocFX 2.43 1308 Thursday, June 13, 2019 Approved
DocFX 2.42.4 4077 Friday, May 24, 2019 Approved
DocFX 2.42.3 1586 Monday, May 13, 2019 Approved
DocFX 2.42.2 377 Friday, May 10, 2019 Approved
DocFX 2.42.1 2200 Tuesday, April 23, 2019 Approved
DocFX 2.42 823 Friday, April 19, 2019 Approved
DocFX 2.41 2953 Friday, March 29, 2019 Approved
DocFX 2.40.12 1757 Monday, March 11, 2019 Approved
DocFX 2.40.11 1909 Friday, February 15, 2019 Approved
DocFX 2.40.10 1168 Friday, February 1, 2019 Approved
DocFX 2.40.9 321 Thursday, January 31, 2019 Approved
DocFX 2.40.8 521 Friday, January 25, 2019 Approved
DocFX 2.40.7 1132 Friday, January 4, 2019 Approved
DocFX 2.40.6 828 Wednesday, December 19, 2018 Approved
DocFX 2.40.5 475 Monday, December 17, 2018 Approved
DocFX 2.40.4 1226 Monday, November 26, 2018 Approved
DocFX 2.40.3 405 Friday, November 23, 2018 Approved
DocFX 2.40.1 2042 Monday, October 29, 2018 Approved
DocFX 2.40 1093 Friday, October 12, 2018 Approved
DocFX 2.39.2 1559 Sunday, September 9, 2018 Approved
DocFX 2.39.1 585 Monday, September 3, 2018 Approved
DocFX 2.39 386 Saturday, September 1, 2018 Approved
DocFX 2.38.1 1157 Thursday, August 16, 2018 Approved
DocFX 2.38 449 Monday, August 13, 2018 Approved
DocFX 2.37.2 1017 Tuesday, July 31, 2018 Approved
DocFX 2.37.1 692 Monday, July 23, 2018 Approved
DocFX 2.37 1463 Friday, June 29, 2018 Approved
DocFX 2.36.2 1104 Wednesday, June 13, 2018 Approved
DocFX 2.36.1 1635 Thursday, May 24, 2018 Approved
DocFX 2.36 648 Friday, May 18, 2018 Approved
DocFX 2.35.4 1115 Wednesday, May 2, 2018 Approved
DocFX 2.35.2 638 Thursday, April 26, 2018 Approved
DocFX 2.35.1 325 Thursday, April 26, 2018 Approved
DocFX 2.35 375 Wednesday, April 25, 2018 Approved
DocFX 2.34 1036 Wednesday, April 4, 2018 Approved
DocFX 2.33.2 357 Monday, April 2, 2018 Approved
DocFX 2.33.1 834 Wednesday, March 21, 2018 Approved
DocFX 2.33 533 Monday, March 19, 2018 Approved
DocFX 2.32.2 829 Friday, March 9, 2018 Approved
DocFX 2.32.1 538 Tuesday, March 6, 2018 Approved
DocFX 2.32 594 Wednesday, February 28, 2018 Approved
DocFX 2.31 1307 Friday, February 2, 2018 Approved
DocFX 2.29.1 1686 Monday, December 25, 2017 Approved
DocFX 2.29 462 Friday, December 22, 2017 Approved
DocFX 2.28.3 613 Tuesday, December 12, 2017 Approved
DocFX 2.28.2 523 Thursday, December 7, 2017 Approved
DocFX 2.28.1 598 Friday, December 1, 2017 Approved
DocFX 2.28 412 Thursday, November 30, 2017 Approved
DocFX 2.27 1231 Thursday, November 9, 2017 Approved
DocFX 2.26.4 973 Monday, October 30, 2017 Approved
DocFX 2.26.3 565 Thursday, October 26, 2017 Approved
DocFX 2.26.1 488 Tuesday, October 24, 2017 Approved
DocFX 2.26 462 Monday, October 23, 2017 Approved
DocFX 2.25.2 735 Tuesday, October 10, 2017 Approved
DocFX 2.25.1 425 Monday, October 9, 2017 Approved
DocFX 2.25 378 Monday, October 9, 2017 Approved
DocFX 2.24 951 Monday, September 11, 2017 Approved
DocFX 2.23.1 878 Tuesday, August 22, 2017 Approved
DocFX 2.23 525 Monday, August 21, 2017 Approved
DocFX 2.22.3 496 Thursday, August 17, 2017 Approved
DocFX 2.22.2 735 Friday, August 4, 2017 Approved
DocFX 2.22 508 Monday, July 31, 2017 Approved
DocFX 2.21.2 593 Monday, July 24, 2017 Approved
DocFX 2.21.1 522 Monday, July 17, 2017 Approved
DocFX 2.21 397 Monday, July 17, 2017 Approved
DocFX 2.20 555 Monday, July 10, 2017 Approved
DocFX 2.19.2 558 Tuesday, June 27, 2017 Approved
DocFX 2.19.1 539 Wednesday, June 21, 2017 Approved
DocFX 2.19 468 Monday, June 19, 2017 Approved
DocFX 2.18.5 420 Thursday, June 15, 2017 Approved
DocFX 2.18.4 580 Friday, June 9, 2017 Approved
DocFX 2.18.3 471 Thursday, June 8, 2017 Approved
DocFX 2.18.2 534 Thursday, June 1, 2017 Approved
DocFX 2.18.1 440 Wednesday, May 31, 2017 Approved
DocFX 2.17.7 479 Wednesday, May 24, 2017 Approved
DocFX 2.17.6 411 Tuesday, May 23, 2017 Approved
DocFX 2.17.5 414 Tuesday, May 23, 2017 Approved
DocFX 2.17.4 521 Friday, May 12, 2017 Approved
DocFX 2.17.3 429 Thursday, May 11, 2017 Approved
DocFX 2.17.2 473 Tuesday, May 9, 2017 Approved
DocFX 2.17.1 401 Monday, May 8, 2017 Approved
DocFX 2.17 517 Thursday, May 4, 2017 Approved
DocFX 2.16.8 407 Wednesday, May 3, 2017 Approved
DocFX 2.16.7 638 Wednesday, April 26, 2017 Approved
DocFX 2.16.2 503 Wednesday, April 19, 2017 Approved
DocFX 2.16.1 404 Wednesday, April 19, 2017 Approved
DocFX 2.16 511 Monday, April 17, 2017 Approved
DocFX 2.15.5 595 Wednesday, April 5, 2017 Approved
DocFX 2.15.4 485 Saturday, April 1, 2017 Approved
DocFX 2.15.3 473 Wednesday, March 29, 2017 Approved
DocFX 2.15.2 402 Wednesday, March 29, 2017 Approved
DocFX 2.15.1 441 Tuesday, March 28, 2017 Approved
DocFX 2.14.1 580 Monday, March 20, 2017 Approved
DocFX 2.14 454 Monday, March 20, 2017 Approved
DocFX 2.13.2 1588 Thursday, March 16, 2017 Approved
DocFX 2.13.1 565 Tuesday, March 7, 2017 Approved
DocFX 2.13 419 Monday, March 6, 2017 Approved
DocFX 2.12.1 4140 Tuesday, February 14, 2017 Approved
DocFX 2.12 495 Monday, February 13, 2017 Approved
DocFX 2.11.3 521 Tuesday, February 7, 2017 Approved
DocFX 2.11.2 609 Wednesday, January 25, 2017 Approved
DocFX 2.11.1 415 Tuesday, January 24, 2017 Approved
DocFX 2.10.2 729 Wednesday, January 4, 2017 Approved
DocFX 2.10.1 428 Tuesday, January 3, 2017 Approved
DocFX 2.10 458 Tuesday, January 3, 2017 Approved
DocFX 2.9.3 686 Thursday, December 15, 2016 Approved
DocFX 2.9.2 486 Wednesday, December 14, 2016 Approved
DocFX 2.9.1 437 Tuesday, December 13, 2016 Approved
DocFX 2.9 493 Monday, December 12, 2016 Approved
DocFX 2.8.2 607 Friday, November 25, 2016 Approved
DocFX 2.8.1 448 Thursday, November 24, 2016 Approved
DocFX 2.8 450 Tuesday, November 22, 2016 Approved
DocFX 2.7.3 588 Monday, November 7, 2016 Approved
DocFX 2.7.2 559 Wednesday, November 2, 2016 Approved
DocFX 2.7.1 487 Tuesday, November 1, 2016 Approved
DocFX 2.7 473 Monday, October 31, 2016 Approved
DocFX 2.6.3 636 Monday, October 24, 2016 Approved
DocFX 2.6.2 470 Friday, October 21, 2016 Approved
DocFX 2.6.1 517 Tuesday, October 11, 2016 Approved
DocFX 2.6 470 Monday, October 10, 2016 Approved
DocFX 2.5.4 662 Thursday, September 22, 2016 Approved
DocFX 2.5.3 459 Tuesday, September 20, 2016 Approved
DocFX 2.5.2 451 Monday, September 19, 2016 Approved
DocFX 2.5.1 372 Monday, September 19, 2016 Approved
DocFX 2.5 535 Wednesday, September 14, 2016 Approved
DocFX 2.4 538 Monday, August 29, 2016 Approved
DocFX 2.3.1 473 Friday, August 19, 2016 Approved
DocFX 2.3 564 Monday, August 8, 2016 Approved
DocFX 2.2.2 504 Tuesday, July 26, 2016 Approved
DocFX 2.2.1 411 Wednesday, July 20, 2016 Approved
DocFX 2.2 430 Monday, July 18, 2016 Approved
DocFX 2.1 460 Tuesday, June 28, 2016 Approved
DocFX 1.4 525 Thursday, February 18, 2016 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