Please help improving these docs. Feel free to add an issue or create a pull request.
All content is located in source/index.html.md and other files in source/includes/.
These docs are based on Slate. Find more info in the Slate Wiki.
Follow this guide to setup a development environment to verify your content updates or improve the website code:
Make sure to meet Slate's prerequisites (Ruby, …): https://github.com/slatedocs/slate#prerequisites
bundle install
This installs Slate's dependencies.
npm start
This starts a preview web-server (http://localhost:4567). Use this to verify your changes.
More info (https://middlemanapp.com/basics/development-cycle/#middleman-server):
You can create and edit files in the
sourcefolder and see the changes reflected on the preview web-server. You can stop the preview server from the command-line usingCtrl + C.
Once you're done, commit your work and create a pull request. A maintainer of the project is going to review and deploy your changes.
npm run deploy
This builds the docs, creates a commit with the content of the build folder on the gh-pages branch. The changes are then (around a minute later) available at https://docs.openframe.io/.
npm run build
This compiles the docs into the build directory.