api-explorer

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

This repo consists of the following npm modules:

• @readme/api-explorer - the React components that make up the explorer
• @readme/markdown - the markdown parser
• @readme/oas-extensions - an exported object of our OAS extensions
• @readme/oas-to-har - utility to transform an OAS operation into a HAR representation
• @readme/syntax-highlighter - the syntax highlighter in use on ReadMe

Installation

git clone git@github.com:readmeio/api-explorer.git
cd api-explorer
npm install
npx lerna bootstrap

Running the tests

npm test

Usage

To spin up an example server:

npm start

To build the packages for production:

npm run build

To deploy the latest example to gh-pages:

npm run deploy

To publish all modules to npm:

npm run publish

Fetching the latest stylesheet from ReadMe (for the demo site)

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

# Remove relative paths for gh-pages
sed -i '' 's/\.\.\///g' example/bundle-hub2.css

Credits

Dom Harrington

License

ISC