Downloads:

22,761

Downloads of v 2.5.3:

199

Last Update:

26 Jan 2018

Package Maintainer(s):

Software Author(s):

  • Martin Donath

Tags:

mkdocs markdown documentation material foss cross-platform cli

MkDocs Material Theme

This is not the latest version of MkDocs Material Theme available.

2.5.3 | Updated: 26 Jan 2018

Downloads:

22,761

Downloads of v 2.5.3:

199

Maintainer(s):

Software Author(s):

  • Martin Donath

Tags:

mkdocs markdown documentation material foss cross-platform cli

MkDocs Material Theme 2.5.3

This is not the latest version of MkDocs Material Theme available.

This Package Contains an Exempted Check

1 Test Passing and 1 Exempted Test

Hide Checks
Hide Checks

Validation Testing Passed

Verification Testing Exempt:

Dependent package is by-passing verifier, so this package needs the same.

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

>

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

>

To uninstall MkDocs Material Theme, 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-material -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-material -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-material installed
  win_chocolatey:
    name: mkdocs-material
    state: present
    version: 2.5.3
    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-material' do
  action    :install
  version  '2.5.3'
  source   'STEP 3 URL'
end

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


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

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


cChocoPackageInstaller mkdocs-material
{
   Name     = 'mkdocs-material'
   Ensure   = 'Present'
   Version  = '2.5.3'
   Source   = 'STEP 3 URL'
}

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


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

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


salt '*' chocolatey.install mkdocs-material version="2.5.3" 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 26 Jan 2018.

Description

Material is a theme for MkDocs, an excellent static site generator geared towards project documentation. It is built using Google's material design guidelines, full responsive, optimized for touch and pointer devices as well as all sorts of screen sizes.

Features

  • Beautiful, readable and very user-friendly design based on Google's material design guidelines, packed in a full responsive template with a well-defined and easily customizable color palette, great typography, as well as a beautiful search interface and footer.
  • Well-tested and optimized Javascript and CSS including a cross-browser fixed/sticky header, a drawer that even works without Javascript using the checkbox hack with fallbacks, responsive tables that scroll when the screen is too small and well-defined print styles.
  • Extra configuration options like a project logo, links to the authors GitHub and Twitter accounts, display of the amount of stars the project has on GitHub and Google Analytics integration.
  • Easily extendable and customizable due to a well-designed asset pipeline built on-top of Gulp with npm and bower and modular and abstracted style definitions built with SASS.
  • Web application capability on iOS - when the page is saved to the homescreen, it behaves and looks like a native application.
tools\ChocolateyInstall.ps1 
Update-SessionEnvironment

$version = '2.5.3'

$proxy = Get-EffectiveProxy
if ($proxy) {
  Write-Host "Setting CLI proxy: $proxy"
  $env:http_proxy = $env:https_proxy = $proxy
}
python -m pip install mkdocs-material==$version
tools\ChocolateyUninstall.ps1 
python -m pip uninstall mkdocs-material -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.

Version Downloads Last Updated Status
MkDocs Material Theme 5.4.0 51 Monday, June 29, 2020 Approved
MkDocs Material Theme 5.3.3 39 Wednesday, June 24, 2020 Approved
MkDocs Material Theme 5.3.2 27 Sunday, June 21, 2020 Approved
MkDocs Material Theme 5.3.1 12 Saturday, June 20, 2020 Approved
MkDocs Material Theme 5.3.0 45 Monday, June 15, 2020 Approved
MkDocs Material Theme 5.2.3 43 Sunday, June 7, 2020 Approved
MkDocs Material Theme 5.2.2 69 Tuesday, May 26, 2020 Approved
MkDocs Material Theme 5.2.1 44 Friday, May 22, 2020 Approved
MkDocs Material Theme 5.2.0 40 Tuesday, May 19, 2020 Approved
MkDocs Material Theme 5.1.7 30 Saturday, May 16, 2020 Approved
Discussion for the MkDocs Material Theme Package

Ground Rules:

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