Welcome! This site contains the latest Magento developer documentation for ongoing Magento 2.x releases. For additional information, see our Contribution Guide.
Our goal is to provide the Magento community with comprehensive and quality technical documentation. We believe that to accomplish that goal we need experts from the community to share their knowledge with us and each other. We are thankful to all of our contributors for improving Magento documentation.
This site is built by Jekyll, which is an open-source tool developed in Ruby.
You can build the site locally in the following ways:
- Installing the project dependencies locally (Mac, Linux)
- Using a Vagrant virtual machine (Mac, Linux, Windows)
- Build DevDocs in Windows (Windows 7 & 10)
- Building older versions of the documentation
You do not need to set up a webserver to serve the site locally. Jekyll will use its own webserver for this.
Consider to set up the Ruby version defined in .ruby-version. Ruby version manager such as rvm or rbenv can help to manage the correct version for this automatically.
See official documentation for the most recent installation guidelines and available options.
Clone the repository. The first time you are at the devdocs directory, run:
bundle installThe website file structure contains directories pulled from multiple sources, not only this repository. The full list with mapped directories is defined in the Docfile.yml. It includes public and private repositories. To pull all the mapped sources:
rake initDocfile begins with public sources, because the rake init task fails when it attempts to clone content from private repositories without the corresponding permissions.
NOTE By default rake clones using SSH. If you want to clone with HTTPS, you can run it with the
tokenvariable:token=none rake initUse
noneif you do not want to use a real token. To have access to private repositories, you will need a GitHub token with the relevant access permissions.
TIP All the helper CLI commands for this project are implemented using rake. Use the
rake --taskscommand for a complete list of available tasks, or filter the list using a keyword, such asrake --tasks test.
Once you have completed preparing your environment, you can build locally and preview the site in your browser.
-
Using the following rake task, verify all the required dependencies and start the embedded web server:
rake preview
You will see the commands called by the rake task and the corresponding output. Each command is typically highlighted with the magenta color:
~/magento/devdocs (master)$ rake preview Install gems listed in the Gemfile: $ bundle install Using rake 13.0.1 Using public_suffix 4.0.3 <truncated> Bundle complete! 16 Gemfile dependencies, 70 gems now installed. Use `bundle info [gemname]` to see where a bundled gem is installed. Installed! Cleaning after the last site generation: $ bundle exec jekyll clean Configuration file: /Users/user/magento/devdocs/_config.yml Cleaner: Removing /Users/user/magento/devdocs/_site... Cleaner: Removing src/.jekyll-metadata... Cleaner: Removing src/.jekyll-cache... Cleaner: Nothing to do for .sass-cache. Clean! Enabled the default configuration: $ bundle exec jekyll serve --incremental \ --open-url \ --livereload \ --trace \ --plugins _plugins,_checks Configuration file: /Users/user/magento/devdocs/_config.yml Theme Config file: /Users/user/.rvm/gems/ruby-2.6.5/bundler/gems/devdocs-theme-e1a4ff6880d5/ _config.yml Source: /Users/user/magento/devdocs/src Destination: /Users/user/magento/devdocs/_site Incremental build: enabled Generating... Running ["ImageCheck", "HtmlCheck", "LinkCheck", "ScriptCheck", "LinkChecker::DoubleSlashCheck"] on ["/Users/user/magento/devdocs/_site"] on *.html... Ran on 1747 files! HTML-Proofer finished successfully. done in 220.316 seconds. Auto-regeneration: enabled for 'src' LiveReload address: http://127.0.0.1:35729 Server address: http://127.0.0.1:4000/ Server running... press ctrl-c to stop. LiveReload: Browser connected -
The generated website launches automatically in a new tab in your browser.
-
Press
Ctrl+Cin 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.ymlfile or other YAML file with data or configuration requires a fresh build (stop and start the server again withrake preview).
If you do not have access to the private repositories required by Docfile, you can exclude them in _config.local.yml to avoid the link checking report about missing pages.
Create a _config.local.yml file at the root of the project directory and exclude the paths you do not want to generate:
exclude:
- page-builderTIP You can override any other configuration options using this file.
TIP To ignore the
_config.local.ymlfile and preview the site with default configuration, use thepreview:alloption :rake preview:all
The published website contains documentation for the latest Magento releases only. For cases, when you need to view the content as it was for an earlier release, we created tags in this repository. Typically, they point at the commit when the release notes were finalized and published.
To view the list of available tags:
git tag --listTo checkout the version (for example 2.2.0):
git checkout 2.2.0Find guidelines for building the site locally in the checked out README.
NOTE There is no guarantee the site will be built, since it can have dependencies on the external resources that are not available anymore.
If you have questions, open an issue and ask us. We're looking forward to hearing from you!