🚨 With the release of ReadMe's reference guide redesign this repository and codebase has been deprecated.

If you have issues with this legacy API Explorer or our current Reference guides, please email our support team at support@readme.io

api-explorer

Open source components that make up ReadMe's API Explorer.

This repo consists of the following npm modules:

• @readme/api-explorer — React components that make up the API Explorer
• @readme/api-logs — React components for ReadMe Metrics

Installation

git clone git@github.com:readmeio/api-explorer.git
cd api-explorer
npm ci

Running the tests

npm test

Usage

To spin up an example server:

npm start

Fetching the latest stylesheet from ReadMe

# Fetch the latest
curl https://docs.readme.com/css/bundle-hub2.css -o example/bundle-hub2.css