2 Star 0 Fork 0

mirrors_knownasilya/ember-api-docs

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

Ember API Docs Build Status

This project is the versioned API documentation viewer built with Emberjs used at Ember api docs. To view the data generator producing its data, please visit https://github.com/ember-learn/ember-jsonapi-docs

Want to help out?

We'd love to get help working on the next set of issues we're seeing.

If you're a new contributor, come say hi in the Ember Community Slack's team-learning channel, and look for the tags "Good for New Contributors" and "Help Wanted" on our Issues.

Please also see CONTRIBUTING.md.

Quickstart to run locally

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

View at http://localhost:4200

Project Overview

Ember itself is documented using a tool called YUIDoc. YUIDoc creates structured API doc data, which is turned into JSONAPI by a generator, ember-jsonapi-docs. That data is filtered and displayed by this Ember app, ember-api-docs.

This project contains only the API docs portion of Emberjs.com. If you're looking for the rest of the site, see the website and guides repositories.

a11y testing

To run a11y tests, run test_a11y=yes ember serve

Staging Environment

Latest changes from master can be seen on https://ember-api-docs-staging-herokuapp-com.global.ssl.fastly.net

The MIT License (MIT) Copyright (c) 2016 Ember Learning Team and contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

暂无描述 展开 收起
README
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/mirrors_knownasilya/ember-api-docs.git
git@gitee.com:mirrors_knownasilya/ember-api-docs.git
mirrors_knownasilya
ember-api-docs
ember-api-docs
master

搜索帮助