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

This is not the latest version of DocFX available.

  • 1
  • 2
  • 3

Some Checks Have Failed or Are Not Yet Complete

Not All Tests Have Passed


Validation Testing Passed


Verification Testing Passed

Details

Scan Testing Resulted in Flagged:

This package was submitted (and approved) prior to automated virus scanning integration into the package moderation processs.

We recommend clicking the "Details" link to make your own decision on installing this package.

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.19.1'" [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.19.1'" 
$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.19.1'
    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.19.1'
end

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


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

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


package { 'docfx':
  ensure   => '2.19.1',
  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 21 Jun 2017.

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.19.1'
$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
$url        = "https://github.com/dotnet/docfx/releases/download/$version/docfx.zip"
$sha1       = '114587c34e887bbf3ec1c23e4ac32e6b354873da'

$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 37676 Wednesday, July 6, 2022 Approved
DocFX 2.59.2 23730 Monday, April 11, 2022 Approved
DocFX 2.59.1 2465 Thursday, March 31, 2022 Approved
DocFX 2.59.0 20017 Wednesday, January 19, 2022 Approved
DocFX 2.58.9 16806 Thursday, November 4, 2021 Approved
DocFX 2.58.8 455 Wednesday, November 3, 2021 Approved
DocFX 2.58.5 47669 Tuesday, October 26, 2021 Approved
DocFX 2.58.4 13053 Tuesday, September 14, 2021 Approved
DocFX 2.58.2 5548 Tuesday, August 24, 2021 Approved
DocFX 2.58 25788 Wednesday, June 16, 2021 Approved
DocFX 2.57.2 20668 Tuesday, April 20, 2021 Approved
DocFX 2.57.1 2051 Tuesday, April 13, 2021 Approved
DocFX 2.57 831 Friday, April 9, 2021 Approved
DocFX 2.56.7 14898 Tuesday, March 2, 2021 Approved
DocFX 2.56.6 30557 Thursday, December 10, 2020 Approved
DocFX 2.56.5 7089 Tuesday, November 10, 2020 Approved
DocFX 2.56.4 8481 Tuesday, October 20, 2020 Approved
DocFX 2.56.2 20121 Monday, July 27, 2020 Approved
DocFX 2.56.1 4122 Monday, July 6, 2020 Approved
DocFX 2.56 1133 Monday, June 29, 2020 Approved
DocFX 2.55 4298 Friday, June 12, 2020 Approved
DocFX 2.54 3558 Monday, May 25, 2020 Approved
DocFX 2.53.1 2559 Monday, May 11, 2020 Approved
DocFX 2.53 321 Monday, May 11, 2020 Approved
DocFX 2.52 6517 Saturday, April 11, 2020 Approved
DocFX 2.51 13650 Friday, March 20, 2020 Approved
DocFX 2.50 3469 Monday, March 2, 2020 Approved
DocFX 2.49 44655 Monday, February 17, 2020 Approved
DocFX 2.48.1 10173 Monday, January 6, 2020 Approved
DocFX 2.48 7009 Monday, December 9, 2019 Approved
DocFX 2.47 6486 Tuesday, October 29, 2019 Approved
DocFX 2.46 2365 Saturday, October 12, 2019 Approved
DocFX 2.45.1 6618 Thursday, September 12, 2019 Approved
DocFX 2.45 2742 Friday, August 23, 2019 Approved
DocFX 2.44 2958 Friday, August 2, 2019 Approved
DocFX 2.43.4 183 Friday, August 2, 2019 Approved
DocFX 2.43.3 2724 Monday, July 15, 2019 Approved
DocFX 2.43.2 2324 Monday, June 24, 2019 Approved
DocFX 2.43.1 725 Wednesday, June 19, 2019 Approved
DocFX 2.43 1266 Thursday, June 13, 2019 Approved
DocFX 2.42.4 4049 Friday, May 24, 2019 Approved
DocFX 2.42.3 1556 Monday, May 13, 2019 Approved
DocFX 2.42.2 345 Friday, May 10, 2019 Approved
DocFX 2.42.1 2163 Tuesday, April 23, 2019 Approved
DocFX 2.42 793 Friday, April 19, 2019 Approved
DocFX 2.41 2912 Friday, March 29, 2019 Approved
DocFX 2.40.12 1722 Monday, March 11, 2019 Approved
DocFX 2.40.11 1881 Friday, February 15, 2019 Approved
DocFX 2.40.10 1135 Friday, February 1, 2019 Approved
DocFX 2.40.9 289 Thursday, January 31, 2019 Approved
DocFX 2.40.8 482 Friday, January 25, 2019 Approved
DocFX 2.40.7 1096 Friday, January 4, 2019 Approved
DocFX 2.40.6 791 Wednesday, December 19, 2018 Approved
DocFX 2.40.5 440 Monday, December 17, 2018 Approved
DocFX 2.40.4 1181 Monday, November 26, 2018 Approved
DocFX 2.40.3 377 Friday, November 23, 2018 Approved
DocFX 2.40.1 2011 Monday, October 29, 2018 Approved
DocFX 2.40 1057 Friday, October 12, 2018 Approved
DocFX 2.39.2 1523 Sunday, September 9, 2018 Approved
DocFX 2.39.1 554 Monday, September 3, 2018 Approved
DocFX 2.39 351 Saturday, September 1, 2018 Approved
DocFX 2.38.1 1126 Thursday, August 16, 2018 Approved
DocFX 2.38 421 Monday, August 13, 2018 Approved
DocFX 2.37.2 980 Tuesday, July 31, 2018 Approved
DocFX 2.37.1 658 Monday, July 23, 2018 Approved
DocFX 2.37 1417 Friday, June 29, 2018 Approved
DocFX 2.36.2 1069 Wednesday, June 13, 2018 Approved
DocFX 2.36.1 1601 Thursday, May 24, 2018 Approved
DocFX 2.36 618 Friday, May 18, 2018 Approved
DocFX 2.35.4 1068 Wednesday, May 2, 2018 Approved
DocFX 2.35.2 598 Thursday, April 26, 2018 Approved
DocFX 2.35.1 298 Thursday, April 26, 2018 Approved
DocFX 2.35 334 Wednesday, April 25, 2018 Approved
DocFX 2.34 995 Wednesday, April 4, 2018 Approved
DocFX 2.33.2 324 Monday, April 2, 2018 Approved
DocFX 2.33.1 804 Wednesday, March 21, 2018 Approved
DocFX 2.33 496 Monday, March 19, 2018 Approved
DocFX 2.32.2 785 Friday, March 9, 2018 Approved
DocFX 2.32.1 500 Tuesday, March 6, 2018 Approved
DocFX 2.32 560 Wednesday, February 28, 2018 Approved
DocFX 2.31 1253 Friday, February 2, 2018 Approved
DocFX 2.29.1 1652 Monday, December 25, 2017 Approved
DocFX 2.29 419 Friday, December 22, 2017 Approved
DocFX 2.28.3 581 Tuesday, December 12, 2017 Approved
DocFX 2.28.2 487 Thursday, December 7, 2017 Approved
DocFX 2.28.1 558 Friday, December 1, 2017 Approved
DocFX 2.28 381 Thursday, November 30, 2017 Approved
DocFX 2.27 1184 Thursday, November 9, 2017 Approved
DocFX 2.26.4 937 Monday, October 30, 2017 Approved
DocFX 2.26.3 526 Thursday, October 26, 2017 Approved
DocFX 2.26.1 452 Tuesday, October 24, 2017 Approved
DocFX 2.26 430 Monday, October 23, 2017 Approved
DocFX 2.25.2 695 Tuesday, October 10, 2017 Approved
DocFX 2.25.1 392 Monday, October 9, 2017 Approved
DocFX 2.25 339 Monday, October 9, 2017 Approved
DocFX 2.24 919 Monday, September 11, 2017 Approved
DocFX 2.23.1 838 Tuesday, August 22, 2017 Approved
DocFX 2.23 493 Monday, August 21, 2017 Approved
DocFX 2.22.3 457 Thursday, August 17, 2017 Approved
DocFX 2.22.2 697 Friday, August 4, 2017 Approved
DocFX 2.22 477 Monday, July 31, 2017 Approved
DocFX 2.21.2 559 Monday, July 24, 2017 Approved
DocFX 2.21.1 490 Monday, July 17, 2017 Approved
DocFX 2.21 367 Monday, July 17, 2017 Approved
DocFX 2.20 514 Monday, July 10, 2017 Approved
DocFX 2.19.2 526 Tuesday, June 27, 2017 Approved
DocFX 2.19.1 506 Wednesday, June 21, 2017 Approved
DocFX 2.19 437 Monday, June 19, 2017 Approved
DocFX 2.18.5 382 Thursday, June 15, 2017 Approved
DocFX 2.18.4 547 Friday, June 9, 2017 Approved
DocFX 2.18.3 423 Thursday, June 8, 2017 Approved
DocFX 2.18.2 498 Thursday, June 1, 2017 Approved
DocFX 2.18.1 413 Wednesday, May 31, 2017 Approved
DocFX 2.17.7 447 Wednesday, May 24, 2017 Approved
DocFX 2.17.6 373 Tuesday, May 23, 2017 Approved
DocFX 2.17.5 378 Tuesday, May 23, 2017 Approved
DocFX 2.17.4 481 Friday, May 12, 2017 Approved
DocFX 2.17.3 397 Thursday, May 11, 2017 Approved
DocFX 2.17.2 430 Tuesday, May 9, 2017 Approved
DocFX 2.17.1 365 Monday, May 8, 2017 Approved
DocFX 2.17 480 Thursday, May 4, 2017 Approved
DocFX 2.16.8 381 Wednesday, May 3, 2017 Approved
DocFX 2.16.7 605 Wednesday, April 26, 2017 Approved
DocFX 2.16.2 466 Wednesday, April 19, 2017 Approved
DocFX 2.16.1 372 Wednesday, April 19, 2017 Approved
DocFX 2.16 479 Monday, April 17, 2017 Approved
DocFX 2.15.5 559 Wednesday, April 5, 2017 Approved
DocFX 2.15.4 452 Saturday, April 1, 2017 Approved
DocFX 2.15.3 441 Wednesday, March 29, 2017 Approved
DocFX 2.15.2 362 Wednesday, March 29, 2017 Approved
DocFX 2.15.1 411 Tuesday, March 28, 2017 Approved
DocFX 2.14.1 539 Monday, March 20, 2017 Approved
DocFX 2.14 411 Monday, March 20, 2017 Approved
DocFX 2.13.2 1548 Thursday, March 16, 2017 Approved
DocFX 2.13.1 530 Tuesday, March 7, 2017 Approved
DocFX 2.13 378 Monday, March 6, 2017 Approved
DocFX 2.12.1 4112 Tuesday, February 14, 2017 Approved
DocFX 2.12 464 Monday, February 13, 2017 Approved
DocFX 2.11.3 484 Tuesday, February 7, 2017 Approved
DocFX 2.11.2 570 Wednesday, January 25, 2017 Approved
DocFX 2.11.1 380 Tuesday, January 24, 2017 Approved
DocFX 2.10.2 693 Wednesday, January 4, 2017 Approved
DocFX 2.10.1 386 Tuesday, January 3, 2017 Approved
DocFX 2.10 409 Tuesday, January 3, 2017 Approved
DocFX 2.9.3 653 Thursday, December 15, 2016 Approved
DocFX 2.9.2 436 Wednesday, December 14, 2016 Approved
DocFX 2.9.1 404 Tuesday, December 13, 2016 Approved
DocFX 2.9 461 Monday, December 12, 2016 Approved
DocFX 2.8.2 575 Friday, November 25, 2016 Approved
DocFX 2.8.1 414 Thursday, November 24, 2016 Approved
DocFX 2.8 418 Tuesday, November 22, 2016 Approved
DocFX 2.7.3 564 Monday, November 7, 2016 Approved
DocFX 2.7.2 509 Wednesday, November 2, 2016 Approved
DocFX 2.7.1 444 Tuesday, November 1, 2016 Approved
DocFX 2.7 443 Monday, October 31, 2016 Approved
DocFX 2.6.3 602 Monday, October 24, 2016 Approved
DocFX 2.6.2 432 Friday, October 21, 2016 Approved
DocFX 2.6.1 485 Tuesday, October 11, 2016 Approved
DocFX 2.6 444 Monday, October 10, 2016 Approved
DocFX 2.5.4 632 Thursday, September 22, 2016 Approved
DocFX 2.5.3 419 Tuesday, September 20, 2016 Approved
DocFX 2.5.2 416 Monday, September 19, 2016 Approved
DocFX 2.5.1 340 Monday, September 19, 2016 Approved
DocFX 2.5 502 Wednesday, September 14, 2016 Approved
DocFX 2.4 505 Monday, August 29, 2016 Approved
DocFX 2.3.1 440 Friday, August 19, 2016 Approved
DocFX 2.3 508 Monday, August 8, 2016 Approved
DocFX 2.2.2 465 Tuesday, July 26, 2016 Approved
DocFX 2.2.1 377 Wednesday, July 20, 2016 Approved
DocFX 2.2 394 Monday, July 18, 2016 Approved
DocFX 2.1 423 Tuesday, June 28, 2016 Approved
DocFX 1.4 495 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