From eea4ebdaf41a4344f5c5fd5989ae44b69d9d16cd Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 14 Jan 2017 19:24:07 +0100 Subject: [PATCH] Updated Dockerfile and added documentation --- Dockerfile | 5 +++-- README.md | 4 ++++ docs/getting-started.md | 6 ++++++ 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/Dockerfile b/Dockerfile index 52dccd2e2..fb44f001a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -19,9 +19,10 @@ # IN THE SOFTWARE. FROM jfloff/alpine-python:2.7-slim +MAINTAINER Martin Donath -# Set work directory -WORKDIR /usr/src +# Set working directory +WORKDIR /docs # Install packages COPY requirements.txt . diff --git a/README.md b/README.md index b87bc3df7..771b56683 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ [![Travis][travis-image]][travis-link] [![Dependencies][deps-image]][deps-link] [![Codacy][codacy-image]][codacy-link] +[![Docker][docker-image]][docker-link] [![PyPI][pypi-image]][pypi-link] [travis-image]: https://travis-ci.org/squidfunk/mkdocs-material.svg @@ -9,9 +10,12 @@ [deps-link]: https://david-dm.org/squidfunk/mkdocs-material?type=dev [codacy-image]: https://api.codacy.com/project/badge/Grade/fe07aa1fa91d453cb69711d3885c5d7e [codacy-link]: https://www.codacy.com/app/squidfunk/mkdocs-material?utm_source=github.com&utm_medium=referral&utm_content=squidfunk/mkdocs-material&utm_campaign=Badge_Grade + [docker-image]: https://img.shields.io/docker/pulls/squidfunk/mkdocs-material.svg + [docker-link]: https://hub.docker.com/r/squidfunk/mkdocs-material/ [pypi-image]: https://img.shields.io/pypi/v/mkdocs-material.svg [pypi-link]: https://pypi.python.org/pypi/mkdocs-material + # Material for MkDocs A Material Design theme for [MkDocs](http://www.mkdocs.org). diff --git a/docs/getting-started.md b/docs/getting-started.md index 3508438cd..d117d8499 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -2,6 +2,12 @@ ## Installation +!!! tip "Set up Material using Docker" + + The official [Docker image][1] for Material comes with all dependencies + pre-installed and ready-to-use with the latest version published on PyPI, + packaged in a very small image (27MB compressed). + ### Installing MkDocs Before installing [MkDocs][2], you need to make sure you have Python and `pip`