Repository of documentation for the BP REST API.
This project is based on Slate.
The docs for the latest version of the REST API (v1) are in source/includes/bp-rest-api-v1. Each section of the docs has its own Markdown file. Once you have made changes, you can generate the docs locally with one of the following:
bundle exec middleman build
After this command completes, the generated docs can be found in the build directory. Open the index.html file in your browser to view the local version of the docs site.
vagrant ssh -c "cd /vagrant; bundle exec middleman build"
After this command completes, the generated docs can be found in the build directory. Open the index.html file in your browser to view the local version of the docs site.
docker run --rm --name slate -v $(pwd)/build:/srv/slate/build -v $(pwd)/source:/srv/slate/source slatedocs/slate build
After this command completes, the generated docs can be found in the build directory. Open the index.html file in your browser to view the local version of the docs site.
Note
You may omit the final build argument and get the same result. By default, if given no command, the Dockerfile will run build.
When you merge a PR to the main branch of this repository, a workflow runs that will automatically deploy the generated docs to the gh-pages branch. However, you can also deploy manually with the following:
./deploy.shNote
If using Docker, you will want to run ./deploy.sh --push-only as the final step.
