Skip to content
Snippets Groups Projects
Select Git revision
  • c1e83991e3d3ed68a163031d1a939b7e95bf72f3
  • master default
  • method_check
  • custom_prefix
  • package
  • cookies
  • v2.1.1
  • v2.1.0
  • v2.1.0-rc5
  • v2.1.0-rc4
  • v2.1.0-rc3
  • v2.1.0-rc2
  • v2.1.0-rc1
  • v2.0.7
  • v2.0.6
  • v2.0.5
  • v2.0.4
  • v2.0.3
  • v2.0.2
  • v2.0.1
  • v2.0.0
  • v1.2.8
  • v1.2.7
  • v1.2.6
  • v1.2.5
  • v1.2.4
26 results

utils.go

Blame
  • getting-started.md 17.56 KiB

    Getting started

    Installation

    Installing MkDocs

    Before installing MkDocs, you need to make sure you have Python and pip – the Python package manager – up and running. You can verify if you're already good to go with the following commands:

    python --version
    # Python 2.7.13
    pip --version
    # pip 9.0.1

    Installing and verifying MkDocs is as simple as:

    pip install mkdocs && mkdocs --version
    # mkdocs, version 0.17.1

    Material requires MkDocs >= 0.17.1.

    Installing Material

    using pip

    Material can be installed with pip:

    pip install mkdocs-material

    using choco

    If you're on Windows you can use Chocolatey to install Material:

    choco install mkdocs-material

    This will install all required dependencies like Python and MkDocs.

    cloning from GitHub

    Material can also be used without a system-wide installation by cloning the repository into a subfolder of your project's root directory:

    git clone https://github.com/squidfunk/mkdocs-material.git

    This is especially useful if you want to extend the theme and override some parts of the theme. The theme will reside in the folder mkdocs-material/material.