OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated Dockerfile and added documentation

Browse Source
This commit is contained in:
squidfunk 2017-01-14 19:24:07 +01:00
parent 7b653fac4e
commit eea4ebdaf4
3 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Dockerfile
View File

@ -19,9 +19,10 @@
# IN THE SOFTWARE. # IN THE SOFTWARE.
FROM jfloff/alpine-python:2.7-slim FROM jfloff/alpine-python:2.7-slim
MAINTAINER Martin Donath <martin.donath@squidfunk.com>
# Set work directory # Set working directory
WORKDIR /usr/src WORKDIR /docs
# Install packages # Install packages
COPY requirements.txt . COPY requirements.txt .

4
README.md
View File

@ -1,6 +1,7 @@
[![Travis][travis-image]][travis-link] [![Travis][travis-image]][travis-link]
[![Dependencies][deps-image]][deps-link] [![Dependencies][deps-image]][deps-link]
[![Codacy][codacy-image]][codacy-link] [![Codacy][codacy-image]][codacy-link]
[![Docker][docker-image]][docker-link]
[![PyPI][pypi-image]][pypi-link] [![PyPI][pypi-image]][pypi-link]
[travis-image]: https://travis-ci.org/squidfunk/mkdocs-material.svg [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 [deps-link]: https://david-dm.org/squidfunk/mkdocs-material?type=dev
[codacy-image]: https://api.codacy.com/project/badge/Grade/fe07aa1fa91d453cb69711d3885c5d7e [codacy-image]: https://api.codacy.com/project/badge/Grade/fe07aa1fa91d453cb69711d3885c5d7e
[codacy-link]: https://www.codacy.com/app/squidfunk/mkdocs-material?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=squidfunk/mkdocs-material&amp;utm_campaign=Badge_Grade [codacy-link]: https://www.codacy.com/app/squidfunk/mkdocs-material?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=squidfunk/mkdocs-material&amp;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-image]: https://img.shields.io/pypi/v/mkdocs-material.svg
[pypi-link]: https://pypi.python.org/pypi/mkdocs-material [pypi-link]: https://pypi.python.org/pypi/mkdocs-material
# Material for MkDocs # Material for MkDocs
A Material Design theme for [MkDocs](http://www.mkdocs.org). A Material Design theme for [MkDocs](http://www.mkdocs.org).

6
docs/getting-started.md
View File

@ -2,6 +2,12 @@
## Installation ## 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 ### Installing MkDocs
Before installing [MkDocs][2], you need to make sure you have Python and `pip` Before installing [MkDocs][2], you need to make sure you have Python and `pip`