Name: devdocs
Owner: Magento
Description: Magento Developer Documentation
Created: 2014-03-10 20:54:08.0
Updated: 2018-01-14 04:33:12.0
Pushed: 2018-01-17 21:35:35.0
Homepage: http://devdocs.magento.com
Size: 454160
Language: HTML
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
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:
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.
ew install rbenv ruby-build
Add rbenv to bash so that it loads every time you open a terminal.
ho 'if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi' >> ~/.bash_profile
Source your .bash_profile
file.
urce ~/.bash_profile
Install a specific version of Ruby.
env install 2.4.x
env global 2.4.x
by -v
Install the Bundler gem, which helps with Ruby dependencies.
m install bundler
Run bundle install
the first time you are in the devdocs
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.
ndle exec jekyll serve --incremental
iguration file: /Users/username/Github/devdocs/_config.yml
Source: /Users/username/Github/devdocs
Destination: /Users/username/Github/devdocs/_site
remental build: enabled
Generating...
done in x.x seconds.
o-regeneration: enabled for '/Users/username/Github/devdocs'
Server address: http://127.0.0.1:4000//
rver 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!