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

This is not the latest version of DocFX available.

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

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


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

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


package { 'docfx':
  ensure   => '2.27',
  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 09 Nov 2017.

Description

DocFx is a documentation generation tool for API reference and Markdown files!

DocFX is an API documentation generator for .NET, and currently it supports C# and VB.
It generates API reference documentation from triple-slash comments in your source code.
It also allows you to use Markdown files to create additional topics such as tutorials and how-tos, and to customize the generated reference documentation.
DocFX builds a static HTML website from your source code and Markdown files, which can be easily hosted on any web servers (for example, github.io).
Also, DocFX provides you the flexibility to customize the layout and style of your website through templates.
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.

Features

  • Website from Source Code and Markdown - DocFX generates Documentation directly from source code (.NET, RESTful API, JavaScript, Java, etc...) and Markdown files.
  • Run Everywhere - DocFX runs on Linux, macOS, and Windows. The generated website can be deployed to any web host with no additional configurations, e.g. Github Pages, Azure Websites...
  • Easy Customization - DocFX provides a flexible way to customize templates and themes easily.

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

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

$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 41833 Wednesday, July 6, 2022 Approved
DocFX 2.59.2 23830 Monday, April 11, 2022 Approved
DocFX 2.59.1 2481 Thursday, March 31, 2022 Approved
DocFX 2.59.0 21796 Wednesday, January 19, 2022 Approved
DocFX 2.58.9 17034 Thursday, November 4, 2021 Approved
DocFX 2.58.8 475 Wednesday, November 3, 2021 Approved
DocFX 2.58.5 52483 Tuesday, October 26, 2021 Approved
DocFX 2.58.4 13069 Tuesday, September 14, 2021 Approved
DocFX 2.58.2 5565 Tuesday, August 24, 2021 Approved
DocFX 2.58 26055 Wednesday, June 16, 2021 Approved
DocFX 2.57.2 21429 Tuesday, April 20, 2021 Approved
DocFX 2.57.1 2067 Tuesday, April 13, 2021 Approved
DocFX 2.57 846 Friday, April 9, 2021 Approved
DocFX 2.56.7 15134 Tuesday, March 2, 2021 Approved
DocFX 2.56.6 33703 Thursday, December 10, 2020 Approved
DocFX 2.56.5 7103 Tuesday, November 10, 2020 Approved
DocFX 2.56.4 8783 Tuesday, October 20, 2020 Approved
DocFX 2.56.2 20141 Monday, July 27, 2020 Approved
DocFX 2.56.1 4139 Monday, July 6, 2020 Approved
DocFX 2.56 1149 Monday, June 29, 2020 Approved
DocFX 2.55 4357 Friday, June 12, 2020 Approved
DocFX 2.54 3573 Monday, May 25, 2020 Approved
DocFX 2.53.1 2578 Monday, May 11, 2020 Approved
DocFX 2.53 342 Monday, May 11, 2020 Approved
DocFX 2.52 6534 Saturday, April 11, 2020 Approved
DocFX 2.51 13669 Friday, March 20, 2020 Approved
DocFX 2.50 3489 Monday, March 2, 2020 Approved
DocFX 2.49 47552 Monday, February 17, 2020 Approved
DocFX 2.48.1 10208 Monday, January 6, 2020 Approved
DocFX 2.48 7438 Monday, December 9, 2019 Approved
DocFX 2.47 6504 Tuesday, October 29, 2019 Approved
DocFX 2.46 2386 Saturday, October 12, 2019 Approved
DocFX 2.45.1 6639 Thursday, September 12, 2019 Approved
DocFX 2.45 2761 Friday, August 23, 2019 Approved
DocFX 2.44 2987 Friday, August 2, 2019 Approved
DocFX 2.43.4 198 Friday, August 2, 2019 Approved
DocFX 2.43.3 2746 Monday, July 15, 2019 Approved
DocFX 2.43.2 2342 Monday, June 24, 2019 Approved
DocFX 2.43.1 741 Wednesday, June 19, 2019 Approved
DocFX 2.43 1289 Thursday, June 13, 2019 Approved
DocFX 2.42.4 4064 Friday, May 24, 2019 Approved
DocFX 2.42.3 1574 Monday, May 13, 2019 Approved
DocFX 2.42.2 362 Friday, May 10, 2019 Approved
DocFX 2.42.1 2184 Tuesday, April 23, 2019 Approved
DocFX 2.42 811 Friday, April 19, 2019 Approved
DocFX 2.41 2933 Friday, March 29, 2019 Approved
DocFX 2.40.12 1741 Monday, March 11, 2019 Approved
DocFX 2.40.11 1899 Friday, February 15, 2019 Approved
DocFX 2.40.10 1152 Friday, February 1, 2019 Approved
DocFX 2.40.9 306 Thursday, January 31, 2019 Approved
DocFX 2.40.8 499 Friday, January 25, 2019 Approved
DocFX 2.40.7 1118 Friday, January 4, 2019 Approved
DocFX 2.40.6 808 Wednesday, December 19, 2018 Approved
DocFX 2.40.5 455 Monday, December 17, 2018 Approved
DocFX 2.40.4 1198 Monday, November 26, 2018 Approved
DocFX 2.40.3 396 Friday, November 23, 2018 Approved
DocFX 2.40.1 2027 Monday, October 29, 2018 Approved
DocFX 2.40 1077 Friday, October 12, 2018 Approved
DocFX 2.39.2 1544 Sunday, September 9, 2018 Approved
DocFX 2.39.1 568 Monday, September 3, 2018 Approved
DocFX 2.39 370 Saturday, September 1, 2018 Approved
DocFX 2.38.1 1142 Thursday, August 16, 2018 Approved
DocFX 2.38 438 Monday, August 13, 2018 Approved
DocFX 2.37.2 999 Tuesday, July 31, 2018 Approved
DocFX 2.37.1 677 Monday, July 23, 2018 Approved
DocFX 2.37 1438 Friday, June 29, 2018 Approved
DocFX 2.36.2 1089 Wednesday, June 13, 2018 Approved
DocFX 2.36.1 1619 Thursday, May 24, 2018 Approved
DocFX 2.36 633 Friday, May 18, 2018 Approved
DocFX 2.35.4 1086 Wednesday, May 2, 2018 Approved
DocFX 2.35.2 618 Thursday, April 26, 2018 Approved
DocFX 2.35.1 313 Thursday, April 26, 2018 Approved
DocFX 2.35 354 Wednesday, April 25, 2018 Approved
DocFX 2.34 1014 Wednesday, April 4, 2018 Approved
DocFX 2.33.2 339 Monday, April 2, 2018 Approved
DocFX 2.33.1 818 Wednesday, March 21, 2018 Approved
DocFX 2.33 516 Monday, March 19, 2018 Approved
DocFX 2.32.2 806 Friday, March 9, 2018 Approved
DocFX 2.32.1 520 Tuesday, March 6, 2018 Approved
DocFX 2.32 582 Wednesday, February 28, 2018 Approved
DocFX 2.31 1278 Friday, February 2, 2018 Approved
DocFX 2.29.1 1670 Monday, December 25, 2017 Approved
DocFX 2.29 445 Friday, December 22, 2017 Approved
DocFX 2.28.3 598 Tuesday, December 12, 2017 Approved
DocFX 2.28.2 503 Thursday, December 7, 2017 Approved
DocFX 2.28.1 575 Friday, December 1, 2017 Approved
DocFX 2.28 401 Thursday, November 30, 2017 Approved
DocFX 2.27 1202 Thursday, November 9, 2017 Approved
DocFX 2.26.4 951 Monday, October 30, 2017 Approved
DocFX 2.26.3 543 Thursday, October 26, 2017 Approved
DocFX 2.26.1 471 Tuesday, October 24, 2017 Approved
DocFX 2.26 446 Monday, October 23, 2017 Approved
DocFX 2.25.2 719 Tuesday, October 10, 2017 Approved
DocFX 2.25.1 408 Monday, October 9, 2017 Approved
DocFX 2.25 356 Monday, October 9, 2017 Approved
DocFX 2.24 934 Monday, September 11, 2017 Approved
DocFX 2.23.1 855 Tuesday, August 22, 2017 Approved
DocFX 2.23 511 Monday, August 21, 2017 Approved
DocFX 2.22.3 477 Thursday, August 17, 2017 Approved
DocFX 2.22.2 714 Friday, August 4, 2017 Approved
DocFX 2.22 493 Monday, July 31, 2017 Approved
DocFX 2.21.2 576 Monday, July 24, 2017 Approved
DocFX 2.21.1 505 Monday, July 17, 2017 Approved
DocFX 2.21 384 Monday, July 17, 2017 Approved
DocFX 2.20 536 Monday, July 10, 2017 Approved
DocFX 2.19.2 542 Tuesday, June 27, 2017 Approved
DocFX 2.19.1 522 Wednesday, June 21, 2017 Approved
DocFX 2.19 455 Monday, June 19, 2017 Approved
DocFX 2.18.5 403 Thursday, June 15, 2017 Approved
DocFX 2.18.4 563 Friday, June 9, 2017 Approved
DocFX 2.18.3 443 Thursday, June 8, 2017 Approved
DocFX 2.18.2 521 Thursday, June 1, 2017 Approved
DocFX 2.18.1 430 Wednesday, May 31, 2017 Approved
DocFX 2.17.7 465 Wednesday, May 24, 2017 Approved
DocFX 2.17.6 392 Tuesday, May 23, 2017 Approved
DocFX 2.17.5 397 Tuesday, May 23, 2017 Approved
DocFX 2.17.4 500 Friday, May 12, 2017 Approved
DocFX 2.17.3 415 Thursday, May 11, 2017 Approved
DocFX 2.17.2 449 Tuesday, May 9, 2017 Approved
DocFX 2.17.1 383 Monday, May 8, 2017 Approved
DocFX 2.17 498 Thursday, May 4, 2017 Approved
DocFX 2.16.8 394 Wednesday, May 3, 2017 Approved
DocFX 2.16.7 626 Wednesday, April 26, 2017 Approved
DocFX 2.16.2 486 Wednesday, April 19, 2017 Approved
DocFX 2.16.1 388 Wednesday, April 19, 2017 Approved
DocFX 2.16 496 Monday, April 17, 2017 Approved
DocFX 2.15.5 577 Wednesday, April 5, 2017 Approved
DocFX 2.15.4 470 Saturday, April 1, 2017 Approved
DocFX 2.15.3 458 Wednesday, March 29, 2017 Approved
DocFX 2.15.2 379 Wednesday, March 29, 2017 Approved
DocFX 2.15.1 429 Tuesday, March 28, 2017 Approved
DocFX 2.14.1 562 Monday, March 20, 2017 Approved
DocFX 2.14 430 Monday, March 20, 2017 Approved
DocFX 2.13.2 1567 Thursday, March 16, 2017 Approved
DocFX 2.13.1 547 Tuesday, March 7, 2017 Approved
DocFX 2.13 397 Monday, March 6, 2017 Approved
DocFX 2.12.1 4129 Tuesday, February 14, 2017 Approved
DocFX 2.12 480 Monday, February 13, 2017 Approved
DocFX 2.11.3 501 Tuesday, February 7, 2017 Approved
DocFX 2.11.2 588 Wednesday, January 25, 2017 Approved
DocFX 2.11.1 401 Tuesday, January 24, 2017 Approved
DocFX 2.10.2 709 Wednesday, January 4, 2017 Approved
DocFX 2.10.1 405 Tuesday, January 3, 2017 Approved
DocFX 2.10 428 Tuesday, January 3, 2017 Approved
DocFX 2.9.3 671 Thursday, December 15, 2016 Approved
DocFX 2.9.2 458 Wednesday, December 14, 2016 Approved
DocFX 2.9.1 425 Tuesday, December 13, 2016 Approved
DocFX 2.9 477 Monday, December 12, 2016 Approved
DocFX 2.8.2 589 Friday, November 25, 2016 Approved
DocFX 2.8.1 433 Thursday, November 24, 2016 Approved
DocFX 2.8 438 Tuesday, November 22, 2016 Approved
DocFX 2.7.3 578 Monday, November 7, 2016 Approved
DocFX 2.7.2 531 Wednesday, November 2, 2016 Approved
DocFX 2.7.1 461 Tuesday, November 1, 2016 Approved
DocFX 2.7 458 Monday, October 31, 2016 Approved
DocFX 2.6.3 623 Monday, October 24, 2016 Approved
DocFX 2.6.2 451 Friday, October 21, 2016 Approved
DocFX 2.6.1 500 Tuesday, October 11, 2016 Approved
DocFX 2.6 459 Monday, October 10, 2016 Approved
DocFX 2.5.4 650 Thursday, September 22, 2016 Approved
DocFX 2.5.3 443 Tuesday, September 20, 2016 Approved
DocFX 2.5.2 433 Monday, September 19, 2016 Approved
DocFX 2.5.1 360 Monday, September 19, 2016 Approved
DocFX 2.5 520 Wednesday, September 14, 2016 Approved
DocFX 2.4 523 Monday, August 29, 2016 Approved
DocFX 2.3.1 459 Friday, August 19, 2016 Approved
DocFX 2.3 526 Monday, August 8, 2016 Approved
DocFX 2.2.2 485 Tuesday, July 26, 2016 Approved
DocFX 2.2.1 397 Wednesday, July 20, 2016 Approved
DocFX 2.2 409 Monday, July 18, 2016 Approved
DocFX 2.1 444 Tuesday, June 28, 2016 Approved
DocFX 1.4 512 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