These docs use Slate to convert markdown files into the Bullhorn Rest API Docs Site.
You're going to need:
- Ruby 2.7+ (we recommend using rbenv or RVM)
- Bundler -
gem install bundler
# Install dependencies
bundle install
# Start the local development server
bundle exec middleman serverYou can now see the docs at http://localhost:4567
# Build the Docker image
docker-compose build
# Run the development server
docker-compose up-
Import
Code Generation.postman_collection.jsonto Postman -
Fill out the script parameters under the 'Pre-request scripts' tab as follows:
- If documentation has already been generated for your entity, copy and paste the full file contents as the
currentDocumentationparameter - If generating documentation for a new entity, fill out the
originalEntityparameter with the name of the entity (no spaces) - For either of the above cases, if the entity belongs to a specific mission, fill out the
originalEntityMissionparameter with the mission name
- If documentation has already been generated for your entity, copy and paste the full file contents as the
-
Send the request
-
View your Postman console (
View -> Show Postman Console, orCtrl+Alt+Con Windows) and copy the new documentation -
Paste the new documentation in the corresponding file in this repository
To deploy to GitHub Pages:
# Build and deploy the site
bundle exec rake publishThis will build the static site and push it to the gh-pages branch.
This documentation site is built with:
- Middleman 4.6 - Static site generator
- Sass/SCSS - For styling with variables and mixins
- Ruby 3.0 - Runtime environment
- Sprockets - Asset pipeline for CSS/JS compilation
- SCSS files are compiled automatically by Sprockets
- The site uses a responsive design that works on desktop and mobile
- Syntax highlighting is provided by Rouge
- Search functionality is built-in for easy navigation
- Bundle install fails: Make sure you have Ruby 2.7+ installed
- Middleman server won't start: Check that all dependencies are installed with
bundle install - CSS not loading: Ensure SCSS files are properly named and located in
source/stylesheets/
For more information about Slate, see the official Slate documentation.