mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2026-03-13 10:22:08 +08:00
55089042d8
Main changes: * Use gulpfile now (build was getting way too disorganized with custom tasks; gulpfiles are much easier to build clean custom tasks with than Grunt. * View README#Development for updated commands * Docs written for ionContent, ionHeaderBar, ionInfiniteScroll. * Docs are pushed to ajoslin's fork of ionic-site until they reach a * point where they can be published. **TODO, In Order of Priority** 1. Finish writing source-documentation for all existing components 2. Add multiple versions of docs (one per release & nightly, latest stable release docs being shown by default) 3. Add examples generation 4. Add searchbar to docs
71 lines
2.0 KiB
HTML
71 lines
2.0 KiB
HTML
<@ extends "base.template.html" @>
|
|
|
|
<@ block content @>
|
|
<h1>
|
|
<@ if doc.title @><$ doc.title | marked $><@ else @><$ doc.name | code $><@ endif @>
|
|
</h1>
|
|
|
|
<$ doc.description | marked $>
|
|
|
|
<@ if doc.name != 'ng' and doc.name != 'auto' @>
|
|
<h2>Installation</h2>
|
|
|
|
<p>First include <$ doc.packageFile | code $> in your HTML:</p>
|
|
|
|
<@ code @>
|
|
<script src="angular.js">
|
|
<script src="<$ doc.packageFile $>">
|
|
<@ endcode @>
|
|
|
|
<p>You can download this file from the following places:</p>
|
|
<ul>
|
|
<li>
|
|
<a href="https://developers.google.com/speed/libraries/devguide#angularjs">Google CDN</a><br>
|
|
e.g. <$ ("//ajax.googleapis.com/ajax/libs/angularjs/X.Y.Z/" + doc.packageFile) | code $>
|
|
</li>
|
|
<li>
|
|
<a href="http://bower.io">Bower</a><br>
|
|
e.g. <@ code @>bower install <$ doc.packageName $>@X.Y.Z<@ endcode @>
|
|
</li>
|
|
<li>
|
|
<a href="http://code.angularjs.org/">code.angularjs.org</a><br>
|
|
e.g. <@ code @>"//code.angularjs.org/X.Y.Z/<$ doc.packageFile $>"<@ endcode @>
|
|
</li>
|
|
</ul>
|
|
<p>where X.Y.Z is the AngularJS version you are running.</p>
|
|
<p>Then load the module in your application by adding it as a dependent module:</p>
|
|
<@ code @>
|
|
angular.module('app', ['<$ doc.name $>']);
|
|
<@ endcode @>
|
|
|
|
<p>With that you're ready to get started!</p>
|
|
<@ endif @>
|
|
|
|
<div class="component-breakdown">
|
|
<h2>Module Components</h2>
|
|
<@ for componentGroup in doc.componentGroups @>
|
|
<div>
|
|
<h3 class="component-heading" id="<$ componentGroup.groupType | dashCase $>"><$ componentGroup.groupType | title $></h3>
|
|
<table class="definition-table">
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<@ for component in componentGroup.components @>
|
|
<tr>
|
|
<td><$ component.id | link(component.name, component) $></td>
|
|
<td><$ component.description | firstParagraph | marked $></td>
|
|
</tr>
|
|
<@ endfor @>
|
|
</table>
|
|
</div>
|
|
<@ endfor @>
|
|
</div>
|
|
|
|
<@ if doc.usage @>
|
|
<h2>Usage</h2>
|
|
<$ doc.usage | marked $>
|
|
<@ endif @>
|
|
|
|
<@ endblock @>
|