Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Build DevDocs with Docker

Jeff Matthews edited this page Apr 1, 2020 · 3 revisions

Docker provides a quick and easy way to build and preview the documentation. You do not need to install Ruby dependencies manually. This Docker solution launches Jekyll inside the container in watch mode.

Every change of a markdown file automatically triggers a rebuild of the documentation.

NOTE: The DevDocs project uses custom rake tooling and plugins that may not be supported in the Docker image.

  1. Install Docker. If you have Docker installed, launch the Docker application.

  2. Clone the DevDocs repository.

  3. Change to the devdocs directory.

  4. Build and start the Docker environment.

    docker-compose up
    
  5. Use the server address URL provided by the system response.

    For example:

    jekyll_1  |     Server address: http://127.0.0.1:4000/
    jekyll_1  |   Server running... press ctrl-c to stop.
    
  6. Press Ctrl+C in the serve terminal to stop the server.