Giter Club home page Giter Club logo

docker-mkdocs's Introduction

mkdocs

Docker container for running mkdocs documentation static site generator.

Usage

Run mkdocs serve command in background. Should allow you to view the site on http://localhost:8000

docker run --rm -v $(pwd):/data -p 8000:8000 -d nicksantamaria/mkdocs serve -a 0.0.0.0:8000

Run mkdocs build command.

docker run --rm -v $(pwd):/data nicksantamaria/mkdocs build

Tags

There is a build for both Alpine Linux and Debian Jessie. Images are built weekly (Sunday night UTC), you have these choices for tags.

  • latest - most recent Alpine image.
  • alpine - most recent Alpine image.
  • jessie - most recent Debian Jessie image.
  • [mkdocs-version]-alpine - Specific version of mkdocs on Alpine.
  • [mkdocs-version]-jessie - Specific version of mkdocs on Debian Jessie.

Only the latest version of mkdocs is built each week, pinning to an older version stop upstream security patches.

Themes

For convenience, the following themes are bundled in the container:

docker-mkdocs's People

Contributors

nicksantamaria avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.