Unpacking Software Livestream

Join our monthly Unpacking Software livestream to hear about the latest news, chat and opinion on packaging, software deployment and lifecycle management!

Learn More

Chocolatey Product Spotlight

Join the Chocolatey Team on our regular monthly stream where we put a spotlight on the most recent Chocolatey product releases. You'll have a chance to have your questions answered in a live Ask Me Anything format.

Learn More

Chocolatey Coding Livestream

Join us for the Chocolatey Coding Livestream, where members of our team dive into the heart of open source development by coding live on various Chocolatey projects. Tune in to witness real-time coding, ask questions, and gain insights into the world of package management. Don't miss this opportunity to engage with our team and contribute to the future of Chocolatey!

Learn More

Calling All Chocolatiers! Whipping Up Windows Automation with Chocolatey Central Management

Webinar from
Wednesday, 17 January 2024

We are delighted to announce the release of Chocolatey Central Management v0.12.0, featuring seamless Deployment Plan creation, time-saving duplications, insightful Group Details, an upgraded Dashboard, bug fixes, user interface polishing, and refined documentation. As an added bonus we'll have members of our Solutions Engineering team on-hand to dive into some interesting ways you can leverage the new features available!

Watch On-Demand
Chocolatey Community Coffee Break

Join the Chocolatey Team as we discuss all things Community, what we do, how you can get involved and answer your Chocolatey questions.

Watch The Replays
Chocolatey and Intune Overview

Webinar Replay from
Wednesday, 30 March 2022

At Chocolatey Software we strive for simple, and teaching others. Let us teach you just how simple it could be to keep your 3rd party applications updated across your devices, all with Intune!

Watch On-Demand
Chocolatey For Business. In Azure. In One Click.

Livestream from
Thursday, 9 June 2022

Join James and Josh to show you how you can get the Chocolatey For Business recommended infrastructure and workflow, created, in Azure, in around 20 minutes.

Watch On-Demand
The Future of Chocolatey CLI

Livestream from
Thursday, 04 August 2022

Join Paul and Gary to hear more about the plans for the Chocolatey CLI in the not so distant future. We'll talk about some cool new features, long term asks from Customers and Community and how you can get involved!

Watch On-Demand
Hacktoberfest Tuesdays 2022

Livestreams from
October 2022

For Hacktoberfest, Chocolatey ran a livestream every Tuesday! Re-watch Cory, James, Gary, and Rain as they share knowledge on how to contribute to open-source projects such as Chocolatey CLI.

Watch On-Demand

Downloads:

66,799

Downloads of v 1.3.0:

491

Last Update:

07 Dec 2022

Package Maintainer(s):

Software Author(s):

  • Laurent Ellerbach
  • Martin Tirion

Tags:

docfx tool linter

DocFx Companion Tools

This is not the latest version of DocFx Companion Tools available.

  • 1
  • 2
  • 3

1.3.0 | Updated: 07 Dec 2022

Downloads:

66,799

Downloads of v 1.3.0:

491

Maintainer(s):

Software Author(s):

  • Laurent Ellerbach
  • Martin Tirion

Tags:

docfx tool linter

DocFx Companion Tools 1.3.0

This is not the latest version of DocFx Companion Tools available.

Legal Disclaimer: Neither this package nor Chocolatey Software, Inc. are affiliated with or endorsed by Laurent Ellerbach, Martin Tirion. The inclusion of Laurent Ellerbach, Martin Tirion trademark(s), if any, upon this webpage is solely to identify Laurent Ellerbach, Martin Tirion goods or services and not for commercial purposes.

  • 1
  • 2
  • 3

Some Checks Have Failed or Are Not Yet Complete

Not All Tests Have Passed


Validation Testing Passed


Verification Testing Passed

Details

Scan Testing Resulted in Flagged as a Note:

At least one file within this package has greater than 0 detections, but less than 5

Details
Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

To install DocFx Companion Tools, run the following command from the command line or from PowerShell:

>

To upgrade DocFx Companion Tools, run the following command from the command line or from PowerShell:

>

To uninstall DocFx Companion Tools, run the following command from the command line or from PowerShell:

>

Deployment Method:

NOTE

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

  • 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. Copy Your Script

choco upgrade docfx-companion-tools -y --source="'INTERNAL REPO URL'" --version="'1.3.0'" [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-companion-tools -y --source="'INTERNAL REPO URL'" --version="'1.3.0'" 
$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-companion-tools
  win_chocolatey:
    name: docfx-companion-tools
    version: '1.3.0'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'docfx-companion-tools' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '1.3.0'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller docfx-companion-tools
{
    Name     = "docfx-companion-tools"
    Version  = "1.3.0"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'docfx-companion-tools':
  ensure   => '1.3.0',
  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.

NOTE

Private CDN cached downloads available for licensed customers. Never experience 404 breakages again! Learn more...

Package Approved

This package was approved by moderator TheCakeIsNaOH on 12 Dec 2022.

Description

The DocFx Companion Tools contains a set of utilities for generating documentation from MD-files and source files using DocFx.
It contains these tools:

* DocFxTocGenerator - generates a table of contents from a folder-structure with MD-files.
* DocLinkChecker - a validation tool for checking links and attachments used in MD-files.
* DocLanguageTranslator - an automatic translator of MD-files using Azure Cognitive Services.


tools\chocolateyinstall.ps1
$ErrorActionPreference = 'Stop';

$packageName= 'docfx-companion-tools'
$version = 'v1.3.0'
$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
$url        = "https://github.com/Ellerbach/docfx-companion-tools/releases/download/$version/tools.zip"
$hash = '075BD59C2C06EF2B6E98706C55D5C59B72C5F0CE06FCE2E277D8C6F586352953'

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

Add to Builder Version Downloads Last Updated Status
DocFx Companion Tools 1.22.0 28 Tuesday, October 29, 2024 Approved
DocFx Companion Tools 1.21.0 1282 Monday, September 2, 2024 Approved
DocFx Companion Tools 1.20.0 146 Wednesday, August 21, 2024 Approved
DocFx Companion Tools 1.19.0 1357 Thursday, May 16, 2024 Approved
DocFx Companion Tools 1.18.0 11605 Thursday, January 18, 2024 Approved
DocFx Companion Tools 1.17.0 1975 Friday, December 8, 2023 Approved
DocFx Companion Tools 1.16.0 1470 Wednesday, November 15, 2023 Approved
DocFx Companion Tools 1.15.0 774 Monday, November 6, 2023 Approved
DocFx Companion Tools 1.14.0 199 Thursday, November 2, 2023 Approved
DocFx Companion Tools 1.13.0 663 Tuesday, October 24, 2023 Approved
DocFx Companion Tools 1.12.0 944 Wednesday, October 11, 2023 Approved
DocFx Companion Tools 1.10.0 31774 Wednesday, April 5, 2023 Approved
DocFx Companion Tools 1.9.0 2704 Monday, March 20, 2023 Approved
DocFx Companion Tools 1.8.0 982 Tuesday, March 14, 2023 Approved
DocFx Companion Tools 1.7.0 7303 Tuesday, January 31, 2023 Approved
DocFx Companion Tools 1.6.0 82 Monday, January 30, 2023 Approved
DocFx Companion Tools 1.3.0 491 Wednesday, December 7, 2022 Approved
DocFx Companion Tools 1.2.0 2735 Thursday, February 3, 2022 Approved
DocFx Companion Tools 1.1.0 69 Thursday, February 3, 2022 Approved

This package has no dependencies.

Discussion for the DocFx Companion Tools Package

Ground Rules:

  • This discussion is only about DocFx Companion Tools and the DocFx Companion Tools 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 Companion Tools, 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