Archipelago API Docs

This repo hosts the API documentation for api.archipelago.com.

All the documentation is written in Markdown and compiled with Jekyll. The content lives in the docs folder and uses the Just the Docs Jekyll template.

Deployment

The site is hosted using GitHub pages. Commits to the main branch automatically publish to the live site.

Code Setup

Prerequisites

1. Install Ruby
2. Install Bundler

Local Development

1. Checkout the repo
2. Navigate to the docs directory, this is the root of the Jekyll site
3. Run bundle install to install local development dependencies
4. Run bundle exec jekyll serve to run the site locally
5. Open a browser and load http://localhost:4000 to view the site

Organization

The docs folder is the root of the actual Jekyll site and content. The docs folder is structured as follows:

docs
├── _includes
│   ├── footer_custom.html
├── _sass/color_schemes
│   ├── archipelago-light.scss
├── api
│   ├── index.md
│   ├── other child pages...
├── websocket
│   ├── index.md
│   ├── other child pages...
├── authentication.md
├── errors.md
├── index.md

Workflow and Markdown Extensions

I recommend using VS Code to write and edit the Markdown. The following extensions are very helpful:

• Emoji: for inserting emojis into docs
• Markdown All in One: helpful shortcuts for writing repetitive Markdown
• Markdown Table: for easily creating and formating Markdown tables (please do not leave the tables unformatted)