Welcome to the Chocolatey Community Package Repository! The packages found in this section of the site are provided, maintained, and moderated by the community.
Moderation
Every version of each package undergoes a rigorous moderation process before it goes live that typically includes:
- Security, consistency, and quality checking
- Installation testing
- Virus checking through VirusTotal
- Human moderators who give final review and sign off
More detail at Security and Moderation.
Organizational Use
If you are an organization using Chocolatey, we want your experience to be fully reliable. Due to the nature of this publicly offered repository, reliability cannot be guaranteed. Packages offered here are subject to distribution rights, which means they may need to reach out further to the internet to the official locations to download files at runtime.
Fortunately, distribution rights do not apply for internal use. With any edition of Chocolatey (including the free open source edition), you can host your own packages and cache or internalize existing community packages.
Disclaimer
Your use of the packages on this site means you understand they are not supported or guaranteed in any way. Learn more...
- Passing
- Failing
- Pending
- Unknown / Exempted
Downloads:
226,888
Downloads of v 2.57.1:
1,392
Last Update:
13 Apr 2021
Package Maintainer(s):
Software Author(s):
- Microsoft
Tags:
docfx markdown documentation codecomments GithubFlavoredMarkdown GFM DFM- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
DocFX
- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Downloads:
226,888
Downloads of v 2.57.1:
1,392
Maintainer(s):
Software Author(s):
- Microsoft
Edit Package
To edit the metadata for a package, please upload an updated version of the package.
Chocolatey's Community Package Repository currently does not allow updating package metadata on the website. This helps ensure that the package itself (and the source used to build the package) remains the one true source of package metadata.
This does require that you increment the package version.
All Checks are Passing
2 Passing Test
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
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
-
Open Source
- Download the Package Download
- Follow manual internalization instructions
-
Package Internalizer (C4B)
- Run
choco download docfx --internalize --source=https://community.chocolatey.org/api/v2
(additional options) - Run
choco push --source="'http://internal/odata/repo'"
for package and dependencies - Automate package internalization
- Run
3. Enter your internal repository url
(this should look similar to https://community.chocolatey.org/api/v2)
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'"
$exitCode = $LASTEXITCODE
Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
Exit 0
}
Exit $exitCode
- name: Ensure docfx installed
win_chocolatey:
name: docfx
state: present
version: 2.57.1
source: STEP 3 URL
See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.
chocolatey_package 'docfx' do
action :install
version '2.57.1'
source 'STEP 3 URL'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
Chocolatey::Ensure-Package
(
Name: docfx,
Version: 2.57.1,
Source: STEP 3 URL
);
Requires Otter Chocolatey Extension. See docs at https://inedo.com/den/otter/chocolatey.
cChocoPackageInstaller docfx
{
Name = 'docfx'
Ensure = 'Present'
Version = '2.57.1'
Source = 'STEP 3 URL'
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'docfx':
provider => 'chocolatey',
ensure => '2.57.1',
source => 'STEP 3 URL',
}
Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.
salt '*' chocolatey.install docfx version="2.57.1" source="STEP 3 URL"
See docs at https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.chocolatey.html.
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...
There are versions of this package awaiting moderation . See the Version History section below.
This package was approved as a trusted package on 13 Apr 2021.
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.
$ErrorActionPreference = 'Stop';
$packageName= 'DocFX'
$version = 'v2.57.1'
$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
$url = "https://github.com/dotnet/docfx/releases/download/$version/docfx.zip"
$hash = '442822312681bb9fedb93304211f37a1cc2265c46220f57ab8b4cd373bc38c16'
$packageArgs = @{
packageName = $packageName
unzipLocation = $toolsDir
url = $url
checksum = $hash
checksumType = 'SHA256'
}
Install-ChocolateyZipPackage @packageArgs
Log in or click on link to see number of positives.
- docfx.2.57.1.nupkg (83c65005782a) - ## / 60
- docfx.zip (442822312681) - ## / 61
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.57.2 | 1 | Friday, April 16, 2021 |
Waiting for Maintainer
|
DocFX 2.57.1 | 1392 | Tuesday, April 13, 2021 | Approved |
DocFX 2.57 | 747 | Friday, April 9, 2021 | Approved |
DocFX 2.56.7 | 10333 | Tuesday, March 2, 2021 | Approved |
DocFX 2.56.6 | 17741 | Thursday, December 10, 2020 | Approved |
DocFX 2.56.5 | 6994 | Tuesday, November 10, 2020 | Approved |
DocFX 2.56.4 | 2362 | Tuesday, October 20, 2020 | Approved |
DocFX 2.56.2 | 19930 | Monday, July 27, 2020 | Approved |
DocFX 2.56.1 | 4034 | Monday, July 6, 2020 | Approved |
DocFX 2.56 | 1036 | Monday, June 29, 2020 | Approved |
DocFX 2.55 | 3481 | Friday, June 12, 2020 | Approved |
DocFX 2.54 | 3425 | Monday, May 25, 2020 | Approved |
DocFX 2.53.1 | 2458 | Monday, May 11, 2020 | Approved |
DocFX 2.53 | 189 | Monday, May 11, 2020 | Approved |
DocFX 2.52 | 6357 | Saturday, April 11, 2020 | Approved |
DocFX 2.51 | 5624 | Friday, March 20, 2020 | Approved |
DocFX 2.50 | 3367 | Monday, March 2, 2020 | Approved |
DocFX 2.49 | 16203 | Monday, February 17, 2020 | Approved |
DocFX 2.48.1 | 9341 | Monday, January 6, 2020 | Approved |
DocFX 2.48 | 4759 | Monday, December 9, 2019 | Approved |
DocFX 2.47 | 5048 | Tuesday, October 29, 2019 | Approved |
DocFX 2.46 | 2275 | Saturday, October 12, 2019 | Approved |
DocFX 2.45.1 | 5523 | Thursday, September 12, 2019 | Approved |
DocFX 2.45 | 2625 | Friday, August 23, 2019 | Approved |
DocFX 2.44 | 2856 | Friday, August 2, 2019 | Approved |
DocFX 2.43.4 | 87 | Friday, August 2, 2019 | Approved |
DocFX 2.43.3 | 2623 | Monday, July 15, 2019 | Approved |
DocFX 2.43.2 | 2183 | Monday, June 24, 2019 | Approved |
DocFX 2.43.1 | 621 | Wednesday, June 19, 2019 | Approved |
DocFX 2.43 | 1143 | Thursday, June 13, 2019 | Approved |
DocFX 2.42.4 | 3321 | Friday, May 24, 2019 | Approved |
DocFX 2.42.3 | 1459 | Monday, May 13, 2019 | Approved |
DocFX 2.42.2 | 264 | Friday, May 10, 2019 | Approved |
DocFX 2.42.1 | 2048 | Tuesday, April 23, 2019 | Approved |
DocFX 2.42 | 683 | Friday, April 19, 2019 | Approved |
DocFX 2.41 | 2713 | Friday, March 29, 2019 | Approved |
DocFX 2.40.12 | 1613 | Monday, March 11, 2019 | Approved |
DocFX 2.40.11 | 1784 | Friday, February 15, 2019 | Approved |
DocFX 2.40.10 | 1044 | Friday, February 1, 2019 | Approved |
DocFX 2.40.9 | 206 | Thursday, January 31, 2019 | Approved |
DocFX 2.40.8 | 382 | Friday, January 25, 2019 | Approved |
DocFX 2.40.7 | 1005 | Friday, January 4, 2019 | Approved |
DocFX 2.40.6 | 688 | Wednesday, December 19, 2018 | Approved |
DocFX 2.40.5 | 295 | Monday, December 17, 2018 | Approved |
DocFX 2.40.4 | 1075 | Monday, November 26, 2018 | Approved |
DocFX 2.40.3 | 271 | Friday, November 23, 2018 | Approved |
DocFX 2.40.1 | 1909 | Monday, October 29, 2018 | Approved |
DocFX 2.40 | 972 | Friday, October 12, 2018 | Approved |
DocFX 2.39.2 | 1413 | Sunday, September 9, 2018 | Approved |
DocFX 2.39.1 | 449 | Monday, September 3, 2018 | Approved |
DocFX 2.39 | 240 | Saturday, September 1, 2018 | Approved |
DocFX 2.38.1 | 1025 | Thursday, August 16, 2018 | Approved |
DocFX 2.38 | 331 | Monday, August 13, 2018 | Approved |
DocFX 2.37.2 | 882 | Tuesday, July 31, 2018 | Approved |
DocFX 2.37.1 | 569 | Monday, July 23, 2018 | Approved |
DocFX 2.37 | 1334 | Friday, June 29, 2018 | Approved |
DocFX 2.36.2 | 978 | Wednesday, June 13, 2018 | Approved |
DocFX 2.36.1 | 1532 | Thursday, May 24, 2018 | Approved |
DocFX 2.36 | 536 | Friday, May 18, 2018 | Approved |
DocFX 2.35.4 | 986 | Wednesday, May 2, 2018 | Approved |
DocFX 2.35.2 | 519 | Thursday, April 26, 2018 | Approved |
DocFX 2.35.1 | 206 | Thursday, April 26, 2018 | Approved |
DocFX 2.35 | 255 | Wednesday, April 25, 2018 | Approved |
DocFX 2.34 | 915 | Wednesday, April 4, 2018 | Approved |
DocFX 2.33.2 | 221 | Monday, April 2, 2018 | Approved |
DocFX 2.33.1 | 698 | Wednesday, March 21, 2018 | Approved |
DocFX 2.33 | 392 | Monday, March 19, 2018 | Approved |
DocFX 2.32.2 | 690 | Friday, March 9, 2018 | Approved |
DocFX 2.32.1 | 421 | Tuesday, March 6, 2018 | Approved |
DocFX 2.32 | 461 | Wednesday, February 28, 2018 | Approved |
DocFX 2.31 | 1165 | Friday, February 2, 2018 | Approved |
DocFX 2.29.1 | 1564 | Monday, December 25, 2017 | Approved |
DocFX 2.29 | 319 | Friday, December 22, 2017 | Approved |
DocFX 2.28.3 | 508 | Tuesday, December 12, 2017 | Approved |
DocFX 2.28.2 | 406 | Thursday, December 7, 2017 | Approved |
DocFX 2.28.1 | 467 | Friday, December 1, 2017 | Approved |
DocFX 2.28 | 288 | Thursday, November 30, 2017 | Approved |
DocFX 2.27 | 1102 | Thursday, November 9, 2017 | Approved |
DocFX 2.26.4 | 851 | Monday, October 30, 2017 | Approved |
DocFX 2.26.3 | 441 | Thursday, October 26, 2017 | Approved |
DocFX 2.26.1 | 353 | Tuesday, October 24, 2017 | Approved |
DocFX 2.26 | 311 | Monday, October 23, 2017 | Approved |
DocFX 2.25.2 | 631 | Tuesday, October 10, 2017 | Approved |
DocFX 2.25.1 | 307 | Monday, October 9, 2017 | Approved |
DocFX 2.25 | 263 | Monday, October 9, 2017 | Approved |
DocFX 2.24 | 827 | Monday, September 11, 2017 | Approved |
DocFX 2.23.1 | 750 | Tuesday, August 22, 2017 | Approved |
DocFX 2.23 | 391 | Monday, August 21, 2017 | Approved |
DocFX 2.22.3 | 381 | Thursday, August 17, 2017 | Approved |
DocFX 2.22.2 | 618 | Friday, August 4, 2017 | Approved |
DocFX 2.22 | 384 | Monday, July 31, 2017 | Approved |
DocFX 2.21.2 | 475 | Monday, July 24, 2017 | Approved |
DocFX 2.21.1 | 388 | Monday, July 17, 2017 | Approved |
DocFX 2.21 | 298 | Monday, July 17, 2017 | Approved |
DocFX 2.20 | 437 | Monday, July 10, 2017 | Approved |
DocFX 2.19.2 | 447 | Tuesday, June 27, 2017 | Approved |
DocFX 2.19.1 | 395 | Wednesday, June 21, 2017 | Approved |
DocFX 2.19 | 347 | Monday, June 19, 2017 | Approved |
DocFX 2.18.5 | 303 | Thursday, June 15, 2017 | Approved |
DocFX 2.18.4 | 437 | Friday, June 9, 2017 | Approved |
DocFX 2.18.3 | 339 | Thursday, June 8, 2017 | Approved |
DocFX 2.18.2 | 425 | Thursday, June 1, 2017 | Approved |
DocFX 2.18.1 | 320 | Wednesday, May 31, 2017 | Approved |
DocFX 2.17.7 | 369 | Wednesday, May 24, 2017 | Approved |
DocFX 2.17.6 | 306 | Tuesday, May 23, 2017 | Approved |
DocFX 2.17.5 | 302 | Tuesday, May 23, 2017 | Approved |
DocFX 2.17.4 | 418 | Friday, May 12, 2017 | Approved |
DocFX 2.17.3 | 318 | Thursday, May 11, 2017 | Approved |
DocFX 2.17.2 | 344 | Tuesday, May 9, 2017 | Approved |
DocFX 2.17.1 | 294 | Monday, May 8, 2017 | Approved |
DocFX 2.17 | 403 | Thursday, May 4, 2017 | Approved |
DocFX 2.16.8 | 306 | Wednesday, May 3, 2017 | Approved |
DocFX 2.16.7 | 523 | Wednesday, April 26, 2017 | Approved |
DocFX 2.16.2 | 405 | Wednesday, April 19, 2017 | Approved |
DocFX 2.16.1 | 280 | Wednesday, April 19, 2017 | Approved |
DocFX 2.16 | 377 | Monday, April 17, 2017 | Approved |
DocFX 2.15.5 | 481 | Wednesday, April 5, 2017 | Approved |
DocFX 2.15.4 | 362 | Saturday, April 1, 2017 | Approved |
DocFX 2.15.3 | 364 | Wednesday, March 29, 2017 | Approved |
DocFX 2.15.2 | 290 | Wednesday, March 29, 2017 | Approved |
DocFX 2.15.1 | 326 | Tuesday, March 28, 2017 | Approved |
DocFX 2.14.1 | 440 | Monday, March 20, 2017 | Approved |
DocFX 2.14 | 308 | Monday, March 20, 2017 | Approved |
DocFX 2.13.2 | 1470 | Thursday, March 16, 2017 | Approved |
DocFX 2.13.1 | 451 | Tuesday, March 7, 2017 | Approved |
DocFX 2.13 | 277 | Monday, March 6, 2017 | Approved |
DocFX 2.12.1 | 4020 | Tuesday, February 14, 2017 | Approved |
DocFX 2.12 | 357 | Monday, February 13, 2017 | Approved |
DocFX 2.11.3 | 402 | Tuesday, February 7, 2017 | Approved |
DocFX 2.11.2 | 496 | Wednesday, January 25, 2017 | Approved |
DocFX 2.11.1 | 317 | Tuesday, January 24, 2017 | Approved |
DocFX 2.10.2 | 605 | Wednesday, January 4, 2017 | Approved |
DocFX 2.10.1 | 301 | Tuesday, January 3, 2017 | Approved |
DocFX 2.10 | 275 | Tuesday, January 3, 2017 | Approved |
DocFX 2.9.3 | 570 | Thursday, December 15, 2016 | Approved |
DocFX 2.9.2 | 351 | Wednesday, December 14, 2016 | Approved |
DocFX 2.9.1 | 325 | Tuesday, December 13, 2016 | Approved |
DocFX 2.9 | 374 | Monday, December 12, 2016 | Approved |
DocFX 2.8.2 | 467 | Friday, November 25, 2016 | Approved |
DocFX 2.8.1 | 330 | Thursday, November 24, 2016 | Approved |
DocFX 2.8 | 331 | Tuesday, November 22, 2016 | Approved |
DocFX 2.7.3 | 457 | Monday, November 7, 2016 | Approved |
DocFX 2.7.2 | 412 | Wednesday, November 2, 2016 | Approved |
DocFX 2.7.1 | 331 | Tuesday, November 1, 2016 | Approved |
DocFX 2.7 | 357 | Monday, October 31, 2016 | Approved |
DocFX 2.6.3 | 501 | Monday, October 24, 2016 | Approved |
DocFX 2.6.2 | 352 | Friday, October 21, 2016 | Approved |
DocFX 2.6.1 | 406 | Tuesday, October 11, 2016 | Approved |
DocFX 2.6 | 356 | Monday, October 10, 2016 | Approved |
DocFX 2.5.4 | 540 | Thursday, September 22, 2016 | Approved |
DocFX 2.5.3 | 324 | Tuesday, September 20, 2016 | Approved |
DocFX 2.5.2 | 315 | Monday, September 19, 2016 | Approved |
DocFX 2.5.1 | 262 | Monday, September 19, 2016 | Approved |
DocFX 2.5 | 382 | Wednesday, September 14, 2016 | Approved |
DocFX 2.4 | 415 | Monday, August 29, 2016 | Approved |
DocFX 2.3.1 | 350 | Friday, August 19, 2016 | Approved |
DocFX 2.3 | 417 | Monday, August 8, 2016 | Approved |
DocFX 2.2.2 | 354 | Tuesday, July 26, 2016 | Approved |
DocFX 2.2.1 | 307 | Wednesday, July 20, 2016 | Approved |
DocFX 2.2 | 318 | Monday, July 18, 2016 | Approved |
DocFX 2.1 | 333 | Tuesday, June 28, 2016 | Approved |
DocFX 1.4 | 390 | Thursday, February 18, 2016 | Approved |
© Microsoft Corporation. All rights reserved.
This package has no dependencies.
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.