Change directory into the website cd <folder-name>
Install packages that the website requires rbenv exec bundle install
View the website on your device bundle exec middleman server
👉 See the generated website on http://localhost:4567 in your browser. Any content changes you make to your website will be updated in real time.
To shut down the Middleman instance running on your machine, use ctrl+C.
If you make changes to the config/tech-docs.yml configuration file, you need to restart Middleman to see the changes.
To build the HTML pages from content in your source folder, run:
bundle exec middleman build
Every time you run this command, the build folder gets generated from scratch. This means any changes to the build folder that are not part of the build command will get overwritten.
Do not run bundle update because the website only builds with the current
package versions, given the old version of ruby. You could try using a more
recent version of ruby, and recent versions of all the packages.
Run bundle exec middleman build --verbose to get detailed error messages to help with finding the problem.
Unless stated otherwise, the codebase is released under the MIT License.
This covers both the codebase and any sample code in the documentation.