Notices: This section not yet converted to new layout. Download stats are rolling back out.

DocFX

2.28.2

Package test results are passing.

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 12/8/2017.

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.

To install DocFX, run the following command from the command line or from PowerShell:

C:\> choco install docfx

To upgrade DocFX, run the following command from the command line or from PowerShell:

C:\> choco upgrade docfx

Files

Hide
  • tools\chocolateyinstall.ps1 Show
    $ErrorActionPreference = 'Stop';
    
    $packageName= 'DocFX'
    $version    = 'v2.28.2'
    $toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
    $url        = "https://github.com/dotnet/docfx/releases/download/$version/docfx.zip"
    $sha1       = '0480bced60a8542a84a0b2c5ec45fa0eb6aa708d'
    
    $packageArgs = @{
      packageName   = $packageName
      unzipLocation = $toolsDir
      url           = $url
      checksum      = $sha1
      checksumType  = 'sha1'
    }
    
    Install-ChocolateyZipPackage @packageArgs
    

Virus Scan Results

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.

Dependencies

This package has no dependencies.

Maintainer(s)

Software Author(s)

  • Microsoft

Copyright

© 2015-2017 Microsoft

Tags

Release Notes

See https://github.com/dotnet/docfx/blob/master/RELEASENOTE.md

Version History

Version Downloads Last updated Status
DocFX 2.28.1 200 Friday, December 1, 2017 approved
DocFX 2.28 55 Thursday, November 30, 2017 approved
DocFX 2.27.1 16 Thursday, November 23, 2017 waiting for maintainer
DocFX 2.27 819 Thursday, November 9, 2017 approved
DocFX 2.26.4 546 Monday, October 30, 2017 approved
DocFX 2.26.3 203 Thursday, October 26, 2017 approved
DocFX 2.26.1 111 Tuesday, October 24, 2017 approved
DocFX 2.26 74 Monday, October 23, 2017 approved
Show More

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