Chocolatey Community Coffee Break

Join the Chocolatey Team on our regular monthly stream where we discuss all things Community, what we do, how you can get involved and answer your Chocolatey questions.

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

Announcing Chocolatey Central Management 0.10.0

Livestream from
Thursday, 06 October 2022

We recently released our largest update to Chocolatey Central Management so far. Join Gary and Steph to find out more about Chocolatey Central Management and the new features and fixes we've added to this release.

Watch On-Demand
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
Chocolatey Product Spotlight: Chocolatey 1.2.0 and Chocolatey Licensed Extension 5.0.0

Livestream from
Thursday, 03 November 2022

Join Paul and Gary for this months Chocolatey product livestream where we look at the latest release of Chocolatey 1.2.0, Chocolatey Licensed Extension 5.0.0 and shine a spotlight on the new hook scripts functionality. This opens up so many possibilities for Chocolatey CLI users!

Watch On-Demand
Chocolatey Coding Livestream

Livestream from
Tuesday, 29 November 2022

Join Josh as he adds the ability to manage Chocolatey GUI config and features with the Chocolatey Ansible Collection.

Watch On-Demand
Introduction into Chocolatey with Veeam

Webinar from
Tuesday, 13 December 2022

Join Gary, Paul, and Maurice as they introduce and demonstrate how to use Chocolatey! Questions will be answered live in an Ask Me Anything format.

Watch On-Demand

Downloads:

17,902

Downloads of v 1.4.2:

356

Last Update:

02 Nov 2022

Package Maintainer(s):

Software Author(s):

  • Tom Christie

Tags:

mkdocs markdown documentation foss cross-platform cli

MkDocs

  • 1
  • 2
  • 3

1.4.2 | Updated: 02 Nov 2022

Downloads:

17,902

Downloads of v 1.4.2:

356

Software Author(s):

  • Tom Christie

MkDocs 1.4.2

  • 1
  • 2
  • 3

This Package Contains an Exempted Check

Not All Tests Have Passed


Validation Testing Passed


Verification Testing Exemption:

Python is bypassing verifier, so this package will need to as well.

Details

Scan Testing Successful:

No detections found in any package files

Details
Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

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

>

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

>

To uninstall MkDocs, 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 mkdocs -y --source="'INTERNAL REPO 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 mkdocs -y --source="'INTERNAL REPO URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Install mkdocs
  win_chocolatey:
    name: mkdocs
    version: '1.4.2'
    source: INTERNAL REPO URL
    state: present

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


chocolatey_package 'mkdocs' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '1.4.2'
end

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


cChocoPackageInstaller mkdocs
{
    Name     = "mkdocs"
    Version  = "1.4.2"
    Source   = "INTERNAL REPO URL"
}

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


package { 'mkdocs':
  ensure   => '1.4.2',
  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.

Package Approved

This package was approved as a trusted package on 02 Nov 2022.

Description

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

Features

  • Host anywhere: MkDocs builds completely static HTML sites that you can host on GitHub pages, Amazon S3, or anywhere else you choose.
  • Great themes available: There's a stack of good looking themes available for MkDocs. Choose between the built in themes: mkdocs and readthedocs, select one of the 3rd party themes in the MkDocs wiki, or build your own.
  • Preview your site as you work: The built-in dev-server allows you to preview your documentation as you're writing it. It will even auto-reload and refresh your browser whenever you save your changes.
  • Easy to customize: Get your project documentation looking just the way you want it by customizing the theme.

tools\ChocolateyInstall.ps1
Update-SessionEnvironment

$version = '1.4.2'

$proxy = Get-EffectiveProxy
if ($proxy) {
  Write-Host "Setting CLI proxy: $proxy"
  $env:http_proxy = $env:https_proxy = $proxy
}
python -m pip install mkdocs==$version
tools\ChocolateyUninstall.ps1
python -m pip uninstall mkdocs -y

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
MkDocs 1.4.1 150 Sunday, October 16, 2022 Approved
MkDocs 1.4.0 167 Tuesday, September 27, 2022 Approved
MkDocs 1.3.1 432 Tuesday, July 19, 2022 Approved
MkDocs 1.3.0 630 Sunday, March 27, 2022 Approved
MkDocs 1.2.3 694 Wednesday, October 13, 2021 Approved
MkDocs 1.2.2 664 Monday, July 19, 2021 Approved
MkDocs 1.2.1 478 Wednesday, June 9, 2021 Approved
MkDocs 1.2 131 Monday, June 7, 2021 Approved
MkDocs 1.1.2 2539 Thursday, May 14, 2020 Approved
MkDocs 1.1.1 156 Tuesday, May 12, 2020 Approved
MkDocs 1.1 1036 Sunday, February 23, 2020 Approved
MkDocs 1.0.4 3198 Friday, September 7, 2018 Approved
MkDocs 1.0.3 316 Thursday, August 30, 2018 Approved
MkDocs 1.0.2 282 Wednesday, August 22, 2018 Approved
MkDocs 1.0.1 325 Monday, August 13, 2018 Approved
MkDocs 1.0 328 Saturday, August 4, 2018 Approved
MkDocs 0.17.5 410 Saturday, July 7, 2018 Approved
MkDocs 0.17.4 425 Saturday, June 9, 2018 Approved
MkDocs 0.17.3 835 Wednesday, March 7, 2018 Approved
MkDocs 0.17.2 768 Wednesday, November 15, 2017 Approved
MkDocs 0.17.1 617 Monday, October 30, 2017 Approved
MkDocs 0.17.0 421 Friday, October 20, 2017 Approved
MkDocs 0.16.3 971 Wednesday, April 5, 2017 Approved
MkDocs 0.16.2 439 Tuesday, March 14, 2017 Approved
MkDocs 0.16.1 593 Thursday, December 22, 2016 Approved
MkDocs 0.16.0 541 Tuesday, November 8, 2016 Approved
Discussion for the MkDocs Package

Ground Rules:

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