",
"isStatic": false,
"decorators": [],
"hasGetter": true,
"hasSetter": false
}
],
"parentClassId": null,
"arguments": [],
"yields": [
{
"name": "demo",
"type": "Hash",
"description": ""
},
{
"name": "demo.example",
"type": "Component",
"description": ""
},
{
"name": "demo.snippet",
"type": "Component",
"description": ""
},
{
"name": "demo.liveExample",
"type": "Component",
"description": ""
}
]
}
]
},
{
"id": "ember-cli-addon-docs/components/docs-header/component",
"file": "ember-cli-addon-docs/components/docs-header/component",
"functions": [],
"variables": [],
"classes": [],
"components": [
{
"id": "ember-cli-addon-docs/components/docs-header/component~DocsHeader",
"name": "DocsHeader",
"file": "ember-cli-addon-docs/components/docs-header/component",
"description": "Render a header showing a link to your documentation, your project logo, a\nsearch bar, and a link to your repo on GitHub.
\n
Yields a link contextual component which can be used to add additional\nheader links.
\n
{{#docs-header as |header|}} \n {{#header.link 'sandbox'}} \n Sandbox\n {{/header.link }} \n {{/docs-header }} The prefix of your project, typically "Ember", "EmberCLI" or "EmberData".
\n
By default the prefix will be autodiscovered from the name field of your addon's package.json.
\n
{{docs-header prefix='EmberData'}} The name of your project (without the "ember", "ember-cli" or "ember-data" prefix).
\n
By default the name will be autodiscovered from the name field of your addon's package.json.
\n
{{docs-header name='MyProject'}} A component that renders a hero banner. Useful for your docs site's homepage.
\n
{{docs-hero\n prefix='Ember'\n headding='SuperAddon'\n byline='The best addon ever. Now playing in theaters.'}} The prefix to show, tyipcally of: 'Ember', 'EmberCLI', or 'EmberData'
A component that enables keyboard shortcuts. Press '?' to toggle the keyboard shortcuts dialog.
Just a styled subclass of LinkComponent. Comes in handy when rending links in Markdown templates:
\n
Here I am, telling you about {{docs-link 'another page' 'docs.x-foo'}}A simple component to render an Ember, Ember CLI or Ember Data logo.
Render either the 'ember', 'ember-cli' or 'ember-data' logo:
\n
{{docs-logo logo='ember'}} \n {{docs-logo logo='ember-cli'}} \n {{docs-logo logo='ember-data'}} A snippet component for demonstrating some code
\n
{{docs-snippet name=snippet.name unindent=true language=snippet.language}} The language of the snippet
Whether or not to show the copy button for this snippet
Whether or not the snippet should be unindented
The standard icon class used in addon docs
The main docs viewer component for Ember-CLI addon docs. This component must be placed
\n
{{#docs-viewer as |viewer|}} \n {{#viewer.nav as |nav|}} \n {{nav.item 'Introduction' 'docs.index'}} \n\n {{#nav.subnav as |nav|}} \n {{nav.item 'Subitem' 'docs.items.subitem'}} \n {{/nav.subnav }} \n {{/viewer.nav }} \n\n {{#viewer.main }} \n {{outlet }} \n {{/viewer.main }} \n {{/docs-viewer }} Creates the docs route and api docs routes. Can receive a callback with the\nroutes you want to add to your docs.
\n
import AddonDocsRouter, { docsRoute } from 'ember-cli-addon-docs/router' ;\n\nRouter.map(function (this , function (this .route('usage' );\n });\n});The AddonDocsRouter, which adds some extra functionality. This should be used\ninstead of the standard EmberRouter class in your docs app.
\n
import AddonDocsRouter, { docsRoute } from 'ember-cli-addon-docs/router' ;\nimport config from './config/environment' ;\n\nconst Router = AddonDocsRouter.extend({\n location : config.locationType,\n rootURL : config.rootURL,\n});