Welcome! This site contains the latest Magento developer documentation for ongoing Magento 2.x releases.
To contribute, please fork the develop
branch.
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)
For local builds, you need to install Bundler, and Ruby version manager.
-
Install Homebrew. See the Homebrew site for instructions.
-
Use Homebrew to install a Ruby version manager.
$ brew install rbenv ruby-build
-
Add rbenv to bash so that it loads every time you open a terminal.
$ echo 'if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi' >> ~/.bash_profile
-
Source your
.bash_profile
file.$ source ~/.bash_profile
-
Install a specific version of Ruby.
$ rbenv install 2.4.x $ rbenv global 2.4.x $ ruby -v
-
Install the Bundler gem, which helps with Ruby dependencies.
$ gem install bundler
-
Run
bundle install
the first time you are in thedevdocs
directory or when you need to pick up theme changes.
Once you have completed preparing your environment, you can build locally and review the site in your browser.
-
Run the serve command.
$ bundle exec jekyll serve --incremental Configuration file: /Users/username/Github/devdocs/_config.yml Source: /Users/username/Github/devdocs Destination: /Users/username/Github/devdocs/_site Incremental build: enabled Generating... done in x.x seconds. Auto-regeneration: enabled for '/Users/username/Github/devdocs' Server address: http://127.0.0.1:4000// Server running... press ctrl-c to stop.
-
Use the Server address URL
http://127.0.0.1:4000/
in a browser to preview the content. -
Press
Ctrl+C
in the serve terminal to stop the server.
TIP
Leave the serve terminal open and running. Every time you save changes to a file, it automatically regenerates the site so you can test the output immediately. Changing the_config.yml
file requires a fresh build. Using the--incremental
option limits re-builds to posts and pages that have changed.
This Docker container contains everything necessary to run Jekyll3 for working with Magento DevDocs.
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!