README.md

Ember API Docs Data

The content of this repository is synced to the s3://api-docs.emberjs.com S3 bucket via a GitHub Action. The data is consumed by the API Docs Viewer.

These files are auto-generated via https://github.com/ember-learn/ember-jsonapi-docs

Previewing these docs in the front end

If you want to see how these docs will look in the front end app, clone ember-api-docs and then clone ember-api-docs-data into the ember-api-docs directory as that is where ember-api-docs will search for the JSON files:

git clone https://github.com/ember-learn/ember-api-docs
cd ember-api-docs
npm install
npm run start:local

git clone https://github.com/ember-learn/ember-api-docs-data
cd ember-api-docs-data
yarn install
yarn serve

The JSON files will be served at http://localhost:5050 and the app can be viewed in the browser at http://localhost:4200.