Downloads:
780,759
Downloads of v 2.56.4:
8,933
Last Update:
20 Oct 2020
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
This is not the latest version of DocFX available.
- 1
- 2
- 3
2.56.4 | Updated: 20 Oct 2020
- 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:
780,759
Downloads of v 2.56.4:
8,933
Maintainer(s):
Software Author(s):
- Microsoft
DocFX 2.56.4
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
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:
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
Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)-
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: (additional options)
choco download docfx --internalize --version=2.56.4 --source=https://community.chocolatey.org/api/v2/
-
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'"
- Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade docfx -y --source="'INTERNAL REPO URL'" --version="'2.56.4'" [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.56.4'"
$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.56.4'
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.56.4'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller docfx
{
Name = "docfx"
Version = "2.56.4"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'docfx':
ensure => '2.56.4',
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.
Private CDN cached downloads available for licensed customers. Never experience 404 breakages again! Learn more...
This package was approved by moderator mkevenaar on 30 Oct 2020.
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.
Log in or click on link to see number of positives.
- docfx.2.56.4.nupkg (6db3eb7d42bb) - ## / 64
- docfx.zip (4ed09c7e6dfe) - ## / 66
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.4 | 226061 | Wednesday, September 7, 2022 | Approved | |
DocFX 2.59.3 | 43332 | Wednesday, July 6, 2022 | Approved | |
DocFX 2.59.2 | 23840 | Monday, April 11, 2022 | Approved | |
DocFX 2.59.1 | 2487 | Thursday, March 31, 2022 | Approved | |
DocFX 2.59.0 | 22819 | Wednesday, January 19, 2022 | Approved | |
DocFX 2.58.9 | 17051 | Thursday, November 4, 2021 | Approved | |
DocFX 2.58.8 | 480 | Wednesday, November 3, 2021 | Approved | |
DocFX 2.58.5 | 54278 | Tuesday, October 26, 2021 | Approved | |
DocFX 2.58.4 | 13076 | Tuesday, September 14, 2021 | Approved | |
DocFX 2.58.2 | 5572 | Tuesday, August 24, 2021 | Approved | |
DocFX 2.58 | 26154 | Wednesday, June 16, 2021 | Approved | |
DocFX 2.57.2 | 21990 | Tuesday, April 20, 2021 | Approved | |
DocFX 2.57.1 | 2086 | Tuesday, April 13, 2021 | Approved | |
DocFX 2.57 | 851 | Friday, April 9, 2021 | Approved | |
DocFX 2.56.7 | 15219 | Tuesday, March 2, 2021 | Approved | |
DocFX 2.56.6 | 35181 | Thursday, December 10, 2020 | Approved | |
DocFX 2.56.5 | 7111 | Tuesday, November 10, 2020 | Approved | |
DocFX 2.56.4 | 8933 | Tuesday, October 20, 2020 | Approved | |
DocFX 2.56.2 | 20151 | Monday, July 27, 2020 | Approved | |
DocFX 2.56.1 | 4144 | Monday, July 6, 2020 | Approved | |
DocFX 2.56 | 1157 | Monday, June 29, 2020 | Approved | |
DocFX 2.55 | 4409 | Friday, June 12, 2020 | Approved | |
DocFX 2.54 | 3582 | Monday, May 25, 2020 | Approved | |
DocFX 2.53.1 | 2584 | Monday, May 11, 2020 | Approved | |
DocFX 2.53 | 350 | Monday, May 11, 2020 | Approved | |
DocFX 2.52 | 6538 | Saturday, April 11, 2020 | Approved | |
DocFX 2.51 | 13672 | Friday, March 20, 2020 | Approved | |
DocFX 2.50 | 3492 | Monday, March 2, 2020 | Approved | |
DocFX 2.49 | 48825 | Monday, February 17, 2020 | Approved | |
DocFX 2.48.1 | 10213 | Monday, January 6, 2020 | Approved | |
DocFX 2.48 | 7776 | Monday, December 9, 2019 | Approved | |
DocFX 2.47 | 6508 | Tuesday, October 29, 2019 | Approved | |
DocFX 2.46 | 2394 | Saturday, October 12, 2019 | Approved | |
DocFX 2.45.1 | 6647 | Thursday, September 12, 2019 | Approved | |
DocFX 2.45 | 2766 | Friday, August 23, 2019 | Approved | |
DocFX 2.44 | 2996 | Friday, August 2, 2019 | Approved | |
DocFX 2.43.4 | 211 | Friday, August 2, 2019 | Approved | |
DocFX 2.43.3 | 2751 | Monday, July 15, 2019 | Approved | |
DocFX 2.43.2 | 2348 | Monday, June 24, 2019 | Approved | |
DocFX 2.43.1 | 744 | Wednesday, June 19, 2019 | Approved | |
DocFX 2.43 | 1296 | Thursday, June 13, 2019 | Approved | |
DocFX 2.42.4 | 4070 | Friday, May 24, 2019 | Approved | |
DocFX 2.42.3 | 1577 | Monday, May 13, 2019 | Approved | |
DocFX 2.42.2 | 366 | Friday, May 10, 2019 | Approved | |
DocFX 2.42.1 | 2189 | Tuesday, April 23, 2019 | Approved | |
DocFX 2.42 | 815 | Friday, April 19, 2019 | Approved | |
DocFX 2.41 | 2942 | Friday, March 29, 2019 | Approved | |
DocFX 2.40.12 | 1752 | Monday, March 11, 2019 | Approved | |
DocFX 2.40.11 | 1906 | Friday, February 15, 2019 | Approved | |
DocFX 2.40.10 | 1158 | Friday, February 1, 2019 | Approved | |
DocFX 2.40.9 | 310 | Thursday, January 31, 2019 | Approved | |
DocFX 2.40.8 | 511 | Friday, January 25, 2019 | Approved | |
DocFX 2.40.7 | 1121 | Friday, January 4, 2019 | Approved | |
DocFX 2.40.6 | 819 | Wednesday, December 19, 2018 | Approved | |
DocFX 2.40.5 | 462 | Monday, December 17, 2018 | Approved | |
DocFX 2.40.4 | 1211 | Monday, November 26, 2018 | Approved | |
DocFX 2.40.3 | 400 | Friday, November 23, 2018 | Approved | |
DocFX 2.40.1 | 2031 | Monday, October 29, 2018 | Approved | |
DocFX 2.40 | 1084 | Friday, October 12, 2018 | Approved | |
DocFX 2.39.2 | 1550 | Sunday, September 9, 2018 | Approved | |
DocFX 2.39.1 | 575 | Monday, September 3, 2018 | Approved | |
DocFX 2.39 | 373 | Saturday, September 1, 2018 | Approved | |
DocFX 2.38.1 | 1149 | Thursday, August 16, 2018 | Approved | |
DocFX 2.38 | 441 | Monday, August 13, 2018 | Approved | |
DocFX 2.37.2 | 1006 | Tuesday, July 31, 2018 | Approved | |
DocFX 2.37.1 | 682 | Monday, July 23, 2018 | Approved | |
DocFX 2.37 | 1450 | Friday, June 29, 2018 | Approved | |
DocFX 2.36.2 | 1095 | Wednesday, June 13, 2018 | Approved | |
DocFX 2.36.1 | 1624 | Thursday, May 24, 2018 | Approved | |
DocFX 2.36 | 638 | Friday, May 18, 2018 | Approved | |
DocFX 2.35.4 | 1101 | Wednesday, May 2, 2018 | Approved | |
DocFX 2.35.2 | 627 | Thursday, April 26, 2018 | Approved | |
DocFX 2.35.1 | 317 | Thursday, April 26, 2018 | Approved | |
DocFX 2.35 | 366 | Wednesday, April 25, 2018 | Approved | |
DocFX 2.34 | 1027 | Wednesday, April 4, 2018 | Approved | |
DocFX 2.33.2 | 343 | Monday, April 2, 2018 | Approved | |
DocFX 2.33.1 | 825 | Wednesday, March 21, 2018 | Approved | |
DocFX 2.33 | 520 | Monday, March 19, 2018 | Approved | |
DocFX 2.32.2 | 818 | Friday, March 9, 2018 | Approved | |
DocFX 2.32.1 | 532 | Tuesday, March 6, 2018 | Approved | |
DocFX 2.32 | 585 | Wednesday, February 28, 2018 | Approved | |
DocFX 2.31 | 1291 | Friday, February 2, 2018 | Approved | |
DocFX 2.29.1 | 1675 | Monday, December 25, 2017 | Approved | |
DocFX 2.29 | 450 | Friday, December 22, 2017 | Approved | |
DocFX 2.28.3 | 604 | Tuesday, December 12, 2017 | Approved | |
DocFX 2.28.2 | 512 | Thursday, December 7, 2017 | Approved | |
DocFX 2.28.1 | 587 | Friday, December 1, 2017 | Approved | |
DocFX 2.28 | 403 | Thursday, November 30, 2017 | Approved | |
DocFX 2.27 | 1216 | Thursday, November 9, 2017 | Approved | |
DocFX 2.26.4 | 958 | Monday, October 30, 2017 | Approved | |
DocFX 2.26.3 | 552 | Thursday, October 26, 2017 | Approved | |
DocFX 2.26.1 | 478 | Tuesday, October 24, 2017 | Approved | |
DocFX 2.26 | 453 | Monday, October 23, 2017 | Approved | |
DocFX 2.25.2 | 724 | Tuesday, October 10, 2017 | Approved | |
DocFX 2.25.1 | 414 | Monday, October 9, 2017 | Approved | |
DocFX 2.25 | 370 | Monday, October 9, 2017 | Approved | |
DocFX 2.24 | 939 | Monday, September 11, 2017 | Approved | |
DocFX 2.23.1 | 864 | Tuesday, August 22, 2017 | Approved | |
DocFX 2.23 | 517 | Monday, August 21, 2017 | Approved | |
DocFX 2.22.3 | 485 | Thursday, August 17, 2017 | Approved | |
DocFX 2.22.2 | 724 | Friday, August 4, 2017 | Approved | |
DocFX 2.22 | 499 | Monday, July 31, 2017 | Approved | |
DocFX 2.21.2 | 582 | Monday, July 24, 2017 | Approved | |
DocFX 2.21.1 | 510 | Monday, July 17, 2017 | Approved | |
DocFX 2.21 | 389 | Monday, July 17, 2017 | Approved | |
DocFX 2.20 | 543 | Monday, July 10, 2017 | Approved | |
DocFX 2.19.2 | 549 | Tuesday, June 27, 2017 | Approved | |
DocFX 2.19.1 | 529 | Wednesday, June 21, 2017 | Approved | |
DocFX 2.19 | 460 | Monday, June 19, 2017 | Approved | |
DocFX 2.18.5 | 409 | Thursday, June 15, 2017 | Approved | |
DocFX 2.18.4 | 568 | Friday, June 9, 2017 | Approved | |
DocFX 2.18.3 | 465 | Thursday, June 8, 2017 | Approved | |
DocFX 2.18.2 | 528 | Thursday, June 1, 2017 | Approved | |
DocFX 2.18.1 | 432 | Wednesday, May 31, 2017 | Approved | |
DocFX 2.17.7 | 471 | Wednesday, May 24, 2017 | Approved | |
DocFX 2.17.6 | 401 | Tuesday, May 23, 2017 | Approved | |
DocFX 2.17.5 | 401 | Tuesday, May 23, 2017 | Approved | |
DocFX 2.17.4 | 505 | Friday, May 12, 2017 | Approved | |
DocFX 2.17.3 | 420 | Thursday, May 11, 2017 | Approved | |
DocFX 2.17.2 | 458 | Tuesday, May 9, 2017 | Approved | |
DocFX 2.17.1 | 386 | Monday, May 8, 2017 | Approved | |
DocFX 2.17 | 507 | Thursday, May 4, 2017 | Approved | |
DocFX 2.16.8 | 399 | Wednesday, May 3, 2017 | Approved | |
DocFX 2.16.7 | 632 | Wednesday, April 26, 2017 | Approved | |
DocFX 2.16.2 | 494 | Wednesday, April 19, 2017 | Approved | |
DocFX 2.16.1 | 392 | Wednesday, April 19, 2017 | Approved | |
DocFX 2.16 | 500 | Monday, April 17, 2017 | Approved | |
DocFX 2.15.5 | 582 | Wednesday, April 5, 2017 | Approved | |
DocFX 2.15.4 | 475 | Saturday, April 1, 2017 | Approved | |
DocFX 2.15.3 | 465 | Wednesday, March 29, 2017 | Approved | |
DocFX 2.15.2 | 392 | Wednesday, March 29, 2017 | Approved | |
DocFX 2.15.1 | 434 | Tuesday, March 28, 2017 | Approved | |
DocFX 2.14.1 | 567 | Monday, March 20, 2017 | Approved | |
DocFX 2.14 | 440 | Monday, March 20, 2017 | Approved | |
DocFX 2.13.2 | 1574 | Thursday, March 16, 2017 | Approved | |
DocFX 2.13.1 | 552 | Tuesday, March 7, 2017 | Approved | |
DocFX 2.13 | 405 | Monday, March 6, 2017 | Approved | |
DocFX 2.12.1 | 4131 | Tuesday, February 14, 2017 | Approved | |
DocFX 2.12 | 484 | Monday, February 13, 2017 | Approved | |
DocFX 2.11.3 | 510 | Tuesday, February 7, 2017 | Approved | |
DocFX 2.11.2 | 593 | Wednesday, January 25, 2017 | Approved | |
DocFX 2.11.1 | 407 | Tuesday, January 24, 2017 | Approved | |
DocFX 2.10.2 | 717 | Wednesday, January 4, 2017 | Approved | |
DocFX 2.10.1 | 418 | Tuesday, January 3, 2017 | Approved | |
DocFX 2.10 | 439 | Tuesday, January 3, 2017 | Approved | |
DocFX 2.9.3 | 677 | Thursday, December 15, 2016 | Approved | |
DocFX 2.9.2 | 476 | Wednesday, December 14, 2016 | Approved | |
DocFX 2.9.1 | 429 | Tuesday, December 13, 2016 | Approved | |
DocFX 2.9 | 482 | Monday, December 12, 2016 | Approved | |
DocFX 2.8.2 | 596 | Friday, November 25, 2016 | Approved | |
DocFX 2.8.1 | 440 | Thursday, November 24, 2016 | Approved | |
DocFX 2.8 | 442 | Tuesday, November 22, 2016 | Approved | |
DocFX 2.7.3 | 581 | Monday, November 7, 2016 | Approved | |
DocFX 2.7.2 | 544 | Wednesday, November 2, 2016 | Approved | |
DocFX 2.7.1 | 475 | Tuesday, November 1, 2016 | Approved | |
DocFX 2.7 | 464 | Monday, October 31, 2016 | Approved | |
DocFX 2.6.3 | 629 | Monday, October 24, 2016 | Approved | |
DocFX 2.6.2 | 458 | Friday, October 21, 2016 | Approved | |
DocFX 2.6.1 | 505 | Tuesday, October 11, 2016 | Approved | |
DocFX 2.6 | 462 | Monday, October 10, 2016 | Approved | |
DocFX 2.5.4 | 654 | Thursday, September 22, 2016 | Approved | |
DocFX 2.5.3 | 450 | Tuesday, September 20, 2016 | Approved | |
DocFX 2.5.2 | 437 | Monday, September 19, 2016 | Approved | |
DocFX 2.5.1 | 364 | Monday, September 19, 2016 | Approved | |
DocFX 2.5 | 525 | Wednesday, September 14, 2016 | Approved | |
DocFX 2.4 | 529 | Monday, August 29, 2016 | Approved | |
DocFX 2.3.1 | 466 | Friday, August 19, 2016 | Approved | |
DocFX 2.3 | 541 | Monday, August 8, 2016 | Approved | |
DocFX 2.2.2 | 497 | Tuesday, July 26, 2016 | Approved | |
DocFX 2.2.1 | 400 | Wednesday, July 20, 2016 | Approved | |
DocFX 2.2 | 414 | Monday, July 18, 2016 | Approved | |
DocFX 2.1 | 450 | Tuesday, June 28, 2016 | Approved | |
DocFX 1.4 | 517 | 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.