Downloads:

7,360

Downloads of v 0.17.1:

472

Last Update:

10/30/2017

Package Maintainer(s):

Software Author(s):

  • Tom Christie

Tags:

mkdocs markdown documentation foss cross-platform cli

MkDocs

This is not the latest version of MkDocs available.

0.17.1 | Updated: 10/30/2017

Downloads:

7,360

Downloads of v 0.17.1:

472

Software Author(s):

  • Tom Christie

MkDocs 0.17.1

This is not the latest version of MkDocs available.

This Package Contains an Exempted Check

1 Test Passing and 1 Exempted Test


Validation Testing Passed


Verification Testing Exempt:

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

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:

>

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://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://chocolatey.org/api/v2)

4. Choose your deployment method:


choco upgrade mkdocs -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 mkdocs -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 mkdocs installed
  win_chocolatey:
    name: mkdocs
    state: present
    version: 0.17.1
    source: STEP 3 URL

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

Coming early 2020! Central Managment Reporting available now! More information...


chocolatey_package 'mkdocs' do
  action    :install
  version  '0.17.1'
  source   'STEP 3 URL'
end

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


Chocolatey::Ensure-Package
(
    Name: mkdocs,
    Version: 0.17.1,
    Source: STEP 3 URL
);

Requires Otter Chocolatey Extension. See docs at https://inedo.com/den/otter/chocolatey.


cChocoPackageInstaller mkdocs
{
   Name     = 'mkdocs'
   Ensure   = 'Present'
   Version  = '0.17.1'
   Source   = 'STEP 3 URL'
}

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


package { 'mkdocs':
  provider => 'chocolatey',
  ensure   => '0.17.1',
  source   => 'STEP 3 URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


salt '*' chocolatey.install mkdocs version="0.17.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.

This package was approved as a trusted package on 10/30/2017.

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 = '0.17.1'

python -m pip install mkdocs==$version
tools\ChocolateyUninstall.ps1
python -m pip uninstall mkdocs -y

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
MkDocs 1.0.3 160 Thursday, August 30, 2018 Approved
MkDocs 1.0.2 136 Wednesday, August 22, 2018 Approved
MkDocs 1.0.1 163 Monday, August 13, 2018 Approved
MkDocs 1.0 184 Saturday, August 4, 2018 Approved
MkDocs 0.17.5 251 Saturday, July 7, 2018 Approved
MkDocs 0.17.4 280 Saturday, June 9, 2018 Approved
MkDocs 0.17.3 693 Wednesday, March 7, 2018 Approved
MkDocs 0.17.2 600 Wednesday, November 15, 2017 Approved
MkDocs 0.17.1 472 Monday, October 30, 2017 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