Verify that this repository has been cloned.Verify that Docker Compose is installed.Verify that the Docker engine is installed for the appropriate operating system.If another port is desired, please refer here for further details regarding Docker Compose port mapping. The configuration for the local port ( 4000 by default) is found in the docker-compose.yml file. Visit in a web browser, and you should be presented with a local copy of the Magento DevDocs.Refer here for more details on the use of docker-compose. Run docker-compose up to initialize the build process.Refer here for the official installation instructions.
Download devdocs install#
To use Docker and Docker Compose, first download and install Docker for the appropriate operating system, and then install Docker Compose to execute the docker-compose.yml configuration file. This repository comes with the necessary configuration files for building a local copy of the Magento DevDocs with Docker, using Docker Compose. If you don't have the _ file at the root of your devdocs/ directory, the rake will generate all versions of the documentation. Generates a new preview and opens the landing page in a web browsers.Removes the _site/ directory, which contains previously generated preview files.Checks your environment according to the dependencies in Gemfile.lock.The following example will generate Magento 2.2 documentation only. To minimize build time locally:Ĭreate a _ file at the root of the project directory and exclude all versions except the one that you want to preview. Using the -incremental option limits re-builds to posts and pages that have changed. Changing the _config.yml file requires a fresh build. Every time you save changes to a file, it automatically regenerates the site so you can test the output immediately. Leave the serve terminal open and running. Press Ctrl+C in the serve terminal to stop the server. Use the Server address URL in a browser to preview the content. Configuration file: /Users/username/Github/devdocs/_config.ymlĭestination: /Users/username/Github/devdocs/_siteĪuto-regeneration: enabled for '/Users/username/Github/devdocs'
0 kommentar(er)
