https://github.com/temando/docker-doc-platform
Dockerfile for docker images to support documentation platform.
https://github.com/temando/docker-doc-platform
alpine-linux docker-image mkdocs mkdocs-material
Last synced: 2 months ago
JSON representation
Dockerfile for docker images to support documentation platform.
- Host: GitHub
- URL: https://github.com/temando/docker-doc-platform
- Owner: temando
- License: isc
- Created: 2016-11-14T21:54:35.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-25T06:40:27.000Z (over 7 years ago)
- Last Synced: 2024-12-27T18:22:55.188Z (4 months ago)
- Topics: alpine-linux, docker-image, mkdocs, mkdocs-material
- Size: 19.5 KB
- Stars: 1
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Documentation Platform Docker File
[](https://microbadger.com/images/temandodx/doc-platform "Click for more information.")
[](https://microbadger.com/images/temandodx/doc-platform "Click for more information.")
[](https://hub.docker.com/r/temandodx/doc-platform/ "Click for more information.")
[](https://travis-ci.org/temando/docker-doc-platform "Click for more information.")
This project contains the Docker file required to build the documentation platform Docker image and is based on an [Alpine Linux](https://alpinelinux.org) installation with:
- [Bash](https://www.gnu.org/software/bash/)
- [MkDocs](http://www.mkdocs.org/) with [MkDocs Material](http://squidfunk.github.io/mkdocs-material/) theme.
- [Node](https://nodejs.org/en/)
- [Python](https://www.python.org)
- [Pip](https://pypi.python.org/pypi)
- [AWS CLI](https://aws.amazon.com/cli/)
- [Yarn](https://www.npmjs.com/package/yarn)
- NPM packages:
- [`markdownlint-cli`](https://www.npmjs.com/package/markdownlint-cli)
- [`write-good`](https://www.npmjs.com/package/write-good)
- [`markdown-spellcheck`](https://www.npmjs.com/package/markdown-spellcheck)
- [`phantomjs-prebuilt`](https://www.npmjs.com/package/phantomjs-prebuilt).
## Prerequisites
Install [Docker](https://www.docker.com) to run `docker` commands.
## Building the Docker Image
To build the documentation platform Docker image, run:
```sh
docker build -t {imagename} --build-arg SOURCE_COMMIT=$(git rev-parse --short HEAD) .
```
**Note:**
- `{imagename}` can be any string.
- Syntax shown above works in `bash`.
## Log in to the Docker Image
To log in to the previously built Docker image, run:
```sh
docker run -ti {imagename} sh
```
`{imagename}` can be any string.