@readme/oas-form

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

Showing:

Popularity

Downloads/wk

1.1K

GitHub Stars

78

Maintenance

Last Commit

8d ago

Contributors

25

Package

Dependencies

4

License

Apache-2.0

Type Definitions

Tree-Shakeable

No?

Categories

Readme

🚨 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.

Build

This repo consists of the following npm modules:

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100