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

DocFX

2.16.7

Package test results are passing.

There are versions of this package awaiting moderation . See the Version History section below.

This package was approved as a trusted package on 4/26/2017.

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

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.16.7'
    $toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
    $url        = "https://github.com/dotnet/docfx/releases/download/$version/docfx.zip"
    $sha1       = 'bcb47a9290da24dbcaae31737d855caaf2029a91'
    
    $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.16.6 5 Tuesday, April 25, 2017 waiting for maintainer
DocFX 2.16.5 15 Tuesday, April 25, 2017 waiting for maintainer
DocFX 2.16.4 9 Thursday, April 20, 2017 waiting for maintainer
DocFX 2.16.3 6 Thursday, April 20, 2017 waiting for maintainer
DocFX 2.16.2 128 Wednesday, April 19, 2017 approved
DocFX 2.16.1 6 Wednesday, April 19, 2017 approved
DocFX 2.16 65 Monday, April 17, 2017 approved
DocFX 2.15.5 195 Wednesday, April 5, 2017 approved
DocFX 2.15.4 73 Saturday, April 1, 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