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

DocFX

2.57.1 | Updated: 13 Apr 2021

Downloads:

226,888

Downloads of v 2.57.1:

1,392

Maintainer(s):

Software Author(s):

  • Microsoft

Tags:

docfx markdown documentation codecomments GithubFlavoredMarkdown GFM DFM

DocFX 2.57.1

All Checks are Passing

2 Passing Test

Validation Testing Passed

Verification Testing Passed

Details

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

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

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

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

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