{"id":15015904,"url":"https://github.com/ember-learn/ember-api-docs","last_synced_at":"2025-04-13T02:11:08.014Z","repository":{"id":5639953,"uuid":"47560189","full_name":"ember-learn/ember-api-docs","owner":"ember-learn","description":"Ember API Docs viewer","archived":false,"fork":false,"pushed_at":"2025-03-22T16:19:24.000Z","size":7194,"stargazers_count":72,"open_issues_count":93,"forks_count":115,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-04-04T04:09:53.666Z","etag":null,"topics":["api-documentation","ember","emberjs","hacktoberfest"],"latest_commit_sha":null,"homepage":"https://api.emberjs.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ember-learn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-12-07T15:20:14.000Z","updated_at":"2025-02-27T13:06:23.000Z","dependencies_parsed_at":"2024-01-09T05:02:18.415Z","dependency_job_id":"589f29b6-fa84-4ab1-bc2b-c0d4d45796a4","html_url":"https://github.com/ember-learn/ember-api-docs","commit_stats":{"total_commits":876,"total_committers":77,"mean_commits":"11.376623376623376","dds":0.8984018264840182,"last_synced_commit":"f50f4feaf8c8bac854aa56363038d8bc7472e312"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-learn%2Fember-api-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-learn%2Fember-api-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-learn%2Fember-api-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-learn%2Fember-api-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ember-learn","download_url":"https://codeload.github.com/ember-learn/ember-api-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248654090,"owners_count":21140236,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-documentation","ember","emberjs","hacktoberfest"],"created_at":"2024-09-24T19:48:07.851Z","updated_at":"2025-04-13T02:11:07.955Z","avatar_url":"https://github.com/ember-learn.png","language":"JavaScript","funding_links":[],"categories":["Packages"],"sub_categories":["Examples"],"readme":"[![This project uses GitHub Actions for continuous integration.](https://github.com/ember-learn/ember-api-docs/workflows/CI/badge.svg)](https://github.com/ember-learn/ember-api-docs/actions?query=workflow%3ACI)\n[![This project uses Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/Ember/ember-api-docs)\n\n# [Ember API Docs](https://api.emberjs.com/)\n\nThis project contains only the [API docs](https://api.emberjs.com/) portion of [Emberjs.com](https://emberjs.com/). If you're looking for the rest of the site,\nsee the [website](https://github.com/ember-learn/ember-website)\nand [guides](https://github.com/ember-learn/guides-source) repositories.\n\nThere are many pieces that together create the Ember API docs site:\n- The app in this repository, which fetches and displays the API docs data. It is what you see at\n[https://api.emberjs.com/](https://api.emberjs.com/)\n- The YUIdoc code comments found in the\n[Ember.js codebase](https://github.com/emberjs/ember.js), where the informational content of the API documentation can be edited\n- The data generator that serializes code comments into JSONAPI and\ndeploys the result,\n[ember-jsonapi-docs](https://github.com/ember-learn/ember-jsonapi-docs)\n- [ember-styleguide](https://github.com/ember-learn/ember-styleguide),\na component and styling library shared across apps.\n- [algolia-index-update-scripts](https://github.com/ember-learn/algolia-index-update-scripts) for managing the search feature of the api docs site\n\n## Contributing\n\nNew contributors are welcome! This project is maintained by an all-volunteer team,\nand we are thankful for your help.\n\nThe best way to get started is to find an issue labeled \"good first issue\" or \"help wanted.\" If you have questions or want a buddy to pair with, drop by the #dev-ember-learning channel on the\n[Ember Community Discord](https://discordapp.com/invite/emberjs).\nLike most open-source projects, contributors are encouraged to open an issue\nto propose changes and iterate on ideas before investing time in coding.\nSome tips for working with git/GitHub can be found in\n[Making your first pull request](https://github.com/emberjs/guides/blob/master/CONTRIBUTING.md#making-your-first-pull-request) in the Guides repository.\n\nPlease also see [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## Running in your local environment\n\nember-api-docs expects a folder in its root that links to the `ember-api-docs-data` folder, so you can either use the `npm run clone` script to clone the `ember-api-docs-data` repo into `ember-api-docs`, OR you can create a symbolic link to `ember-api-docs-data` from `ember-api-docs`. You might want to sym-link `ember-api-docs-data` if you are generating new versions of the docs files with `ember-jsonapi-docs`, otherwise you can probably use the clone script.\n\n### Quickstart to run locally\n\nFollow these instructions to run the app using publically available online data.\nYou do not need to run [ember-jsonapi-docs](https://github.com/ember-learn/ember-jsonapi-docs)\nlocally yourself.\n\n```\ngit clone https://github.com/ember-learn/ember-api-docs.git\ncd ember-api-docs\npnpm install\npnpm run clone\npnpm run start\n```\n\nView at http://localhost:4200\n\n### Run locally with a sym-link\n\nClone all of the following repositories into the same directory so they are \"siblings\" on the file system:\n\n- This repository, `ember-api-docs`\n- [ember-api-docs-data](https://github.com/ember-learn/ember-api-docs-data)\n\n```sh\ngit clone https://github.com/ember-learn/ember-api-docs-data\ngit clone https://github.com/ember-learn/ember-api-docs\ncd ember-api-docs\nln -s ../ember-api-docs-data\npnpm install\npnpm start\n```\n\nVisit the app in your browser at [http://localhost:4200](http://localhost:4200)\n\n## a11y testing\n\nTo run a11y tests, run `test_a11y=yes ember serve`\n\n## Linting\n\n* `pnpm run lint:hbs`\n* `pnpm run lint:js`\n* `pnpm run lint:js -- --fix`\n\n## Staging and Deployment\n\nSee the [DEPLOYING.md](https://github.com/ember-learn/ember-api-docs/blob/master/DEPLOYING.md) guide for instructions.\n\n## Building\n\nCross-browser testing provided by:\n\n\u003ca href=\"http://browserstack.com\" target=\"browserstack\"\u003e\u003cimg height=\"70\" src=\"/public/assets/images/browserstack-logo.png\" alt=\"BrowserStack\"\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fember-learn%2Fember-api-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fember-learn%2Fember-api-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fember-learn%2Fember-api-docs/lists"}