https://github.com/andrglo/docker-mkdocs

Simple Docker container for MkDocs documentation site builder tool
https://github.com/andrglo/docker-mkdocs

Last synced: 26 days ago
JSON representation

Simple Docker container for MkDocs documentation site builder tool

• Host: GitHub
• URL: https://github.com/andrglo/docker-mkdocs
• Owner: andrglo
• License: mit
• Created: 2014-12-08T18:11:23.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-03T15:44:41.000Z (about 9 years ago)
• Last Synced: 2024-04-14T05:16:47.919Z (8 months ago)
• Language: Shell
• Size: 156 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MkDocs

This is a simple Docker container for running the [MkDocs](http://www.mkdocs.org) documentation site builder tool

### Usage

#### Build image

```

$ docker build -t andrglo/mkdocs .

```

#### Then

See all available commands

```

$ docker run --rm andrglo/mkdocs help

```

Check version

```

$ docker run --rm andrglo/mkdocs version

```

Create a new project

```

$ docker run --rm -v ~/my/workspace:/workspace andrglo/mkdocs new my-project

```

Webserver for development

```

$ docker run -d -p 8000:8000 -v ~/my/workspace/my-project:/workspace andrglo/mkdocs

```

Build

```

$ docker run --rm -v ~/my/workspace/my-project:/workspace andrglo/mkdocs build

```

Deploy

Upload the directory `~/my/workspace/my-project/site` to your _http server_