Run the docs locally

This document describes how to run Spryker docs locally using Docker. You may want to run docs locally to preview your changes, but it’s not required for contributing.

For instructions on contributing, see Edit the docs locally

Prerequisites

1. Create an account on GitHub.
2. Install GitHub Desktop.
3. Install Docker Desktop.
4. Clone the Spryker docs repository. For detailed instructions, see Clone the Spryker docs repository.

Run the docs

1. In Docker Desktop, click >_Terminal.
2. In terminal, go to the spryker-docs directory. If you didn’t change the default path when cloning the repository, the command to do it looks as follows:

cd Documents/GitHub/spryker-docs

3. Run the docs:

docker compose up

The first launch can take up to 15 minutes. When the build is done, you should see a message that the server is running and its local address. You can access the local copy of Spryker docs by opening http://localhost:4000 in your browser. If you update a file in the repository, it will be automatically refreshed so you can see it on your local website.