Magento Developer Documentation

Welcome! This site contains the latest Magento developer documentation for ongoing Magento 2.x releases.

To contribute, please fork the develop branch.

Building this site

You can build this site locally in the following ways:

• Installing the project dependencies locally (Mac, Linux)
• Using a Docker container (Mac, Linux)
• Using a Vagrant virtual machine (Mac, Linux, Windows)

Build using Jekyll

Currently, building this site requires:

• Ruby v.2.4.x+
• bundler v.1.16.x+

To build this site locally, clone this repository and run in the devdocs directory:

# Install dependencies
$ bundle install

# Run Jekyll server to generate local website
$ bin/jekyll serve --incremental

Visit http://localhost:4000 in your favorite browser!

Build using Docker

This Docker container contains everything necessary to run Jekyll3 for working with Magento DevDocs.

Build using Vagrant

You can deploy the devdocs site locally using this Vagrant project.

---

If you have questions, open an issue and ask us. We're looking forward to hearing from you!

• Follow @MagentoDevDocs

• E-mail us

• Visit our documentation site, built using GitHub pages.