SEC Hub Consumer API Documentation

This is the documentation server for the documentation generated by the Consumer API.

Serve documentation locally

To display the documentation locally on http://localhost:4567, run:

docker-compose up --remove-orphans --build

How to update the documentation

Copy the contents (WITHOUT frontmatter) of the Consumer API's tmp/doc/index.html.md file into this projects source/includes/_consumer_api.md file to update the documentation.

Generating static files

To generate a set of static HTML, CSS, and JS files for production deployment:

docker-compose run --rm web bundle exec middleman build

This will create a bunch of files in the build folder, which can then be deployed to a static file server.