Solidus Guides

If you want to contribute to the Solidus documentation be sure to read the dedicated section first.

The documentation files can be found inside the source/ folder.

---

The Solidus documentation is published with Middleman, and based on https://github.com/joshukraine/middleman-gulp.

Requirements

• Middleman 4.x
• Ruby 2.x
• Yarn

Usage

1. Install ruby gems bundle install

2. Install JavaScript packages yarn install

3. Start the Middleman server. Note that this will also invoke Webpack via the external pipeline.

$ bundle exec middleman server

4. To build HTML and assets for production, run:

$ bundle exec middleman build

5. Set proper base_url in config.rb