This repository was archived by the owner on Nov 19, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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.
-
Install Docker. If you have Docker installed, launch the Docker application.
-
Clone the DevDocs repository.
-
Change to the devdocs directory.
-
Build and start the Docker environment.
docker-compose up
-
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.
-
Press
Ctrl+C
in the serve terminal to stop the server.