Git Product home page Git Product logo

docker_static_website's Introduction

MkDocs in a docker

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.


Author

  • Pratik Thakkar

Usage

Build docker image
$ docker build . -t pthakkar/mkdocs
Build the MkDocs documentation and generate a tar file
$ docker run -t --rm -v /path/to/src:/docs/src -v /path/to/output:/docs/output pthakkar/mkdocs produce
Run as a development server in background. Should allow you to view the site on http://localhost:8000
$ docker run -d -p 8000:8000 -v /path/to/src:/docs/src pthakkar/mkdocs serve

Automated Validation using Jenkins pipeline and Goss

We’ll be using Goss as the testing tool of choice. The installation is simple and only takes a few seconds.

curl -fsSL https://goss.rocks/install | sh
What is Goss?

Goss is a YAML based serverspec alternative tool for validating a server’s configuration. It eases the process of writing tests by allowing the user to generate tests from the current system state. Once the test suite is written they can be executed, waited-on, or served as a health endpoint.

Note: For testing docker containers see the dgoss wrapper.

Note: Once installtion is completed create an environment variable GOSS_FILES_PATH specifying goss.yaml path.

export GOSS_FILES_PATH="/jenkins/workspace/path/"

Demo

MkDocs.in.a.docker.mp4

docker_static_website's People

Contributors

pratik-thakkar avatar pratikt avatar

Watchers

James Cloos avatar  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.