mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2025-08-18 19:21:34 +08:00
chore(docs): remove unnecessary templates
This commit is contained in:
Tim Lancina
79
scripts/docs/templates/api/api.template.html
vendored
79
scripts/docs/templates/api/api.template.html
vendored
@ -1,79 +0,0 @@
|
|||||||
---
|
|
||||||
<@ include "lib/yaml.template.html" @>
|
|
||||||
title: "<@ if doc.docType == "directive" @><$ doc.name | dashCase $><@ else @><$ doc.name $><@ endif @>"
|
|
||||||
header_sub_title: "<$ doc.docType | capital $> in module <$ doc.module $>"
|
|
||||||
doc: "<$ doc.name $>"
|
|
||||||
docType: "<$ doc.docType $>"
|
|
||||||
---
|
|
||||||
|
|
||||||
<div class="improve-docs">
|
|
||||||
<a href='http://github.com/driftyco/ionic/tree/master/<$ doc.relativePath $>#L<$ doc.startingLine $>'>
|
|
||||||
View Source
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<a href='http://github.com/driftyco/ionic/edit/master/<$ doc.relativePath $>#L<$ doc.startingLine $>'>
|
|
||||||
Improve this doc
|
|
||||||
</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<@ block content @>
|
|
||||||
|
|
||||||
<@ block header @>
|
|
||||||
<h1 class="api-title">
|
|
||||||
<@ if doc.docType == "directive" @>
|
|
||||||
<$ doc.name | dashCase $>
|
|
||||||
<@ else @>
|
|
||||||
<$ doc.name $>
|
|
||||||
<@ endif @>
|
|
||||||
<@ if doc.parent @>
|
|
||||||
<br />
|
|
||||||
<small>
|
|
||||||
Child of <$ doc.parent $>
|
|
||||||
</small>
|
|
||||||
<@ endif @>
|
|
||||||
<@ if doc.delegate @>
|
|
||||||
<br/>
|
|
||||||
<small>
|
|
||||||
Delegate: <$ doc.delegate $>
|
|
||||||
</small>
|
|
||||||
<@ endif @>
|
|
||||||
</h1>
|
|
||||||
|
|
||||||
<@ if doc.codepen @>
|
|
||||||
{% include codepen.html id="<$ doc.codepen $>" %}
|
|
||||||
<@ endif @>
|
|
||||||
<@ endblock @>
|
|
||||||
|
|
||||||
<@ block description @>
|
|
||||||
<$ doc.description $>
|
|
||||||
<@ endblock @>
|
|
||||||
|
|
||||||
<@ if doc.deprecated @>
|
|
||||||
<fieldset class="deprecated">
|
|
||||||
<legend>Deprecated API</legend>
|
|
||||||
<$ doc.deprecated| marked $>
|
|
||||||
</fieldset>
|
|
||||||
<@ endif @>
|
|
||||||
|
|
||||||
<@ block dependencies @>
|
|
||||||
<@- if doc.requires @>
|
|
||||||
<h2 id="dependencies">Dependencies</h2>
|
|
||||||
<ul>
|
|
||||||
<@ for require in doc.requires @><li><$ require | link $></li><@ endfor @>
|
|
||||||
</ul>
|
|
||||||
<@ endif -@>
|
|
||||||
<@ endblock @>
|
|
||||||
|
|
||||||
<@ block additional @>
|
|
||||||
<@ endblock @>
|
|
||||||
|
|
||||||
<@ block examples @>
|
|
||||||
<@- if doc.examples @>
|
|
||||||
<h2 id="example">Example</h2>
|
|
||||||
<@- for example in doc.examples -@>
|
|
||||||
<$ example | marked $>
|
|
||||||
<@- endfor -@>
|
|
||||||
<@ endif -@>
|
|
||||||
<@ endblock @>
|
|
||||||
|
|
||||||
<@ endblock @>
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
---
|
|
||||||
<@ include "lib/yaml.template.html" @>
|
|
||||||
title: "<@ if doc.title @><$ doc.title $><@ elif doc.module @><$ doc.groupType | title $>s in module ionic<@ else @>Pages<@ endif @>"
|
|
||||||
header_sub_title: "<$ doc.components.length $> <$ doc.groupType $>s"
|
|
||||||
doc: "<$ doc.groupType $>"
|
|
||||||
docType: "<$ doc.groupType $>"
|
|
||||||
---
|
|
||||||
|
|
||||||
<@ block content @>
|
|
||||||
|
|
||||||
<$ doc.description $>
|
|
||||||
|
|
||||||
<table class="table">
|
|
||||||
<tr>
|
|
||||||
<th>Name</th>
|
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
|
||||||
<@ for page in doc.components @>
|
|
||||||
<tr>
|
|
||||||
<td><$ page.id | link(page.name, page) $></td>
|
|
||||||
<td><$ page.description | firstParagraph | marked $></td>
|
|
||||||
</tr>
|
|
||||||
<@ endfor @>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<@ endblock @>
|
|
||||||
@ -1,9 +0,0 @@
|
|||||||
<@ extends "api/object.template.html" @>
|
|
||||||
|
|
||||||
<@ block related_components @>
|
|
||||||
<@ if doc.providerDoc -@>
|
|
||||||
<li>
|
|
||||||
<a href="<$ doc.providerDoc.path $>">- <$ doc.providerDoc.name $></a>
|
|
||||||
</li>
|
|
||||||
<@- endif @>
|
|
||||||
<@ endblock @>
|
|
||||||
@ -1,56 +0,0 @@
|
|||||||
<@ include "lib/macros.html" -@>
|
|
||||||
<@ extends "api/api.template.html" @>
|
|
||||||
|
|
||||||
<@ block additional @>
|
|
||||||
|
|
||||||
<@ block usage @>
|
|
||||||
<h2 id="usage">Usage</h2>
|
|
||||||
<@ if doc.usage @>
|
|
||||||
<$ doc.usage $>
|
|
||||||
<@ else @>
|
|
||||||
<@ if doc.restrict.element @>
|
|
||||||
|
|
||||||
```html
|
|
||||||
<<$ doc.name | dashCase $>
|
|
||||||
<@- for param in doc.params @>
|
|
||||||
<$ directiveParam(param.alias or param.name, param.type, '="', '"') $>
|
|
||||||
<@- endfor @>>
|
|
||||||
...
|
|
||||||
</<$ doc.name | dashCase $>>
|
|
||||||
```
|
|
||||||
<@ endif -@>
|
|
||||||
|
|
||||||
<@- if doc.restrict.attribute -@>
|
|
||||||
|
|
||||||
```html
|
|
||||||
<<$ doc.element $>
|
|
||||||
<@- for param in doc.params @>
|
|
||||||
<$ directiveParam(param.name, param.type, '="', '"') $>
|
|
||||||
<@- endfor @>>
|
|
||||||
...
|
|
||||||
</<$ doc.element $>>
|
|
||||||
```
|
|
||||||
<@ endif -@>
|
|
||||||
|
|
||||||
<@- if doc.restrict.cssClass -@>
|
|
||||||
|
|
||||||
```html
|
|
||||||
<@ set sep = joiner(' ') @>
|
|
||||||
<<$ doc.element $> class="
|
|
||||||
<@- for param in doc.params -@>
|
|
||||||
<$ sep() $><$ directiveParam(param.name, param.type, ': ', ';') $>
|
|
||||||
<@- endfor @>"> ... </<$ doc.element $>>
|
|
||||||
```
|
|
||||||
<@ endif -@>
|
|
||||||
|
|
||||||
<@- endif @>
|
|
||||||
<@ endblock -@>
|
|
||||||
|
|
||||||
|
|
||||||
<@ if doc.params @>
|
|
||||||
<h2 id="api" style="clear:both;">API</h2>
|
|
||||||
<$ paramTable(doc.params, true) $>
|
|
||||||
<@ endif @>
|
|
||||||
|
|
||||||
<@ include "lib/events.template.html" @>
|
|
||||||
<@ endblock @>
|
|
||||||
26
scripts/docs/templates/api/filter.template.html
vendored
26
scripts/docs/templates/api/filter.template.html
vendored
@ -1,26 +0,0 @@
|
|||||||
<@ include "lib/macros.html" -@>
|
|
||||||
<@ extends "api/api.template.html" @>
|
|
||||||
|
|
||||||
<@ block additional @>
|
|
||||||
<h2>Usage</h2>
|
|
||||||
<h3>In HTML Template Binding</h3>
|
|
||||||
<@ if doc.usage @>
|
|
||||||
<$ doc.usage | code $>
|
|
||||||
<@ else @>
|
|
||||||
<@ code -@>
|
|
||||||
{{ <$ doc.name $>_expression | <$ doc.name $>
|
|
||||||
<@- for param in doc.params @> : <$ param.name $><@ endfor -@>
|
|
||||||
}}
|
|
||||||
<@- endcode @>
|
|
||||||
<@ endif @>
|
|
||||||
|
|
||||||
<h3>In JavaScript</h3>
|
|
||||||
<@ code -@>
|
|
||||||
<@- set sep = joiner(', ') -@>
|
|
||||||
$filter('<$ doc.name $>')(<@ for param in doc.params @><$ sep() $><$ param.name $><@ endfor -@>)
|
|
||||||
<@- endcode @>
|
|
||||||
|
|
||||||
<$ paramTable(doc.params) $>
|
|
||||||
<@ include "lib/this.template.html" @>
|
|
||||||
<@ include "lib/returns.template.html" @>
|
|
||||||
<@ endblock @>
|
|
||||||
@ -1 +0,0 @@
|
|||||||
<@ extends "api/object.template.html" @>
|
|
||||||
28
scripts/docs/templates/api/object.template.html
vendored
28
scripts/docs/templates/api/object.template.html
vendored
@ -1,28 +0,0 @@
|
|||||||
<@ include "lib/macros.html" -@>
|
|
||||||
<@ extends "api/api.template.html" @>
|
|
||||||
|
|
||||||
<@ block additional @>
|
|
||||||
|
|
||||||
<@ if doc.usage @>
|
|
||||||
## Usage
|
|
||||||
<$ doc.usage $>
|
|
||||||
<@ endif @>
|
|
||||||
|
|
||||||
<@ if doc.params or doc.returns or doc.this or doc.kind == 'function' -@>
|
|
||||||
<h2 id="usage">Usage</h2>
|
|
||||||
<@ if doc.usage @>
|
|
||||||
<$ doc.usage $>
|
|
||||||
<@ else @>
|
|
||||||
<$ functionSyntax(doc) $>
|
|
||||||
<@ endif @>
|
|
||||||
|
|
||||||
<$ paramTable(doc.params) $>
|
|
||||||
<@ include "lib/this.template.html" @>
|
|
||||||
<@ include "lib/returns.template.html" @>
|
|
||||||
<@- endif @>
|
|
||||||
|
|
||||||
<@ include "lib/methods.template.html" @>
|
|
||||||
<@ include "lib/events.template.html" @>
|
|
||||||
<@ include "lib/properties.template.html" @>
|
|
||||||
|
|
||||||
<@ endblock @>
|
|
||||||
@ -1 +0,0 @@
|
|||||||
<@ extends "api/object.template.html" @>
|
|
||||||
@ -1,9 +0,0 @@
|
|||||||
<@ extends "api/object.template.html" @>
|
|
||||||
|
|
||||||
<@ block related_components @>
|
|
||||||
<@ if doc.serviceDoc -@>
|
|
||||||
<li>
|
|
||||||
<a href="<$ doc.serviceDoc.path $>">- <$ doc.serviceDoc.name $></a>
|
|
||||||
</li>
|
|
||||||
<@- endif @>
|
|
||||||
<@ endblock @>
|
|
||||||
@ -1,9 +0,0 @@
|
|||||||
<@ extends "api/object.template.html" @>
|
|
||||||
|
|
||||||
<@ block related_components @>
|
|
||||||
<@ if doc.providerDoc -@>
|
|
||||||
<li>
|
|
||||||
<a href="<$ doc.providerDoc.path $>">- <$ doc.providerDoc.name $></a>
|
|
||||||
</li>
|
|
||||||
<@- endif @>
|
|
||||||
<@ endblock @>
|
|
||||||
@ -1 +0,0 @@
|
|||||||
<@ extends "api/object.template.html" @>
|
|
||||||
@ -1,9 +0,0 @@
|
|||||||
<@ extends "api/object.template.html" @>
|
|
||||||
|
|
||||||
<@ block related_components @>
|
|
||||||
<@ if doc.providerDoc -@>
|
|
||||||
<li>
|
|
||||||
<a href="<$ doc.providerDoc.path $>">- <$ doc.providerDoc.name $></a>
|
|
||||||
</li>
|
|
||||||
<@- endif @>
|
|
||||||
<@ endblock @>
|
|
||||||
5
scripts/docs/templates/common.template.html
vendored
5
scripts/docs/templates/common.template.html
vendored
@ -1,5 +1,8 @@
|
|||||||
---
|
---
|
||||||
<@ include "lib/yaml.template.html" @>
|
layout: "v2/docs_base"
|
||||||
|
version: "<$ version.current.name $>"
|
||||||
|
versionHref: "<$ version.current.href $>"
|
||||||
|
path: "<$ doc.path $>"
|
||||||
id: api
|
id: api
|
||||||
title: "<@ if doc.docType == "directive" @><$ doc.name | dashCase $><@ else @><$ doc.name $><@ endif @>"
|
title: "<@ if doc.docType == "directive" @><$ doc.name | dashCase $><@ else @><$ doc.name $><@ endif @>"
|
||||||
header_sub_title: "<$ doc.docType | capital $> in module <$ doc.module $>"
|
header_sub_title: "<$ doc.docType | capital $> in module <$ doc.module $>"
|
||||||
|
|||||||
25
scripts/docs/templates/lib/events.template.html
vendored
25
scripts/docs/templates/lib/events.template.html
vendored
@ -1,25 +0,0 @@
|
|||||||
<@- if doc.events @>
|
|
||||||
<h2>Events</h2>
|
|
||||||
<ul class="events">
|
|
||||||
<@- for event in doc.events @>
|
|
||||||
<li id="<$ event.name $>">
|
|
||||||
<h3><$ event.name $></h3>
|
|
||||||
<div><$ event.description | marked $></div>
|
|
||||||
<@- if event.eventType == 'listen' @>
|
|
||||||
<div class="inline">
|
|
||||||
<h4>Listen on: <$ event.eventTarget $></h4>
|
|
||||||
</div>
|
|
||||||
<@- else @>
|
|
||||||
<div class="inline">
|
|
||||||
<h4>Type:</h4>
|
|
||||||
<div class="type"><$ event.eventType $></div>
|
|
||||||
</div>
|
|
||||||
<div class="inline">
|
|
||||||
<h4>Target:</h4>
|
|
||||||
<div class="target"><$ event.eventTarget $></div>
|
|
||||||
</div>
|
|
||||||
<@ endif -@>
|
|
||||||
</li>
|
|
||||||
<@ endfor -@>
|
|
||||||
</ul>
|
|
||||||
<@ endif -@>
|
|
||||||
54
scripts/docs/templates/lib/macros.html
vendored
54
scripts/docs/templates/lib/macros.html
vendored
@ -1,54 +0,0 @@
|
|||||||
<@ macro typeList(types) -@>
|
|
||||||
<@ set separator = joiner("|") @>
|
|
||||||
<@ for type in types @><$ separator() $><$ type | code $><@ endfor @>
|
|
||||||
<@- endmacro -@>
|
|
||||||
|
|
||||||
<@ macro paramTable(params, isDirective) @>
|
|
||||||
<table class="table" style="margin:0;">
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<th><@ if isDirective @>Attr<@ else @>Param<@ endif @></th>
|
|
||||||
<th>Type</th>
|
|
||||||
<th>Details</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<@ for param in params @>
|
|
||||||
<tr>
|
|
||||||
<td>
|
|
||||||
<$ param.name $>
|
|
||||||
<@ if param.alias @>| <$ param.alias $><@ endif @>
|
|
||||||
<@ if param.type.optional @><div><em>(optional)</em></div><@ endif @>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<$ typeList(param.typeList) $>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<$ param.description | marked $>
|
|
||||||
<@ if param.default @><p><em>(default: <$ param.default $>)</em></p><@ endif @>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<@ endfor @>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<@ endmacro @>
|
|
||||||
|
|
||||||
|
|
||||||
<@- macro directiveParam(name, type, join, sep) @>
|
|
||||||
<@- if type.optional @>[<@ endif -@>
|
|
||||||
<$ name | dashCase $><$ join $><$ type.description $><$ sep $>
|
|
||||||
<@- if type.optional @>]<@ endif -@>
|
|
||||||
<@ endmacro -@>
|
|
||||||
|
|
||||||
<@- macro functionSyntax(fn) @>
|
|
||||||
<@- set sep = joiner(', ') -@>
|
|
||||||
<code><$ fn.name $>(<@- for param in fn.params @><$ sep() $>
|
|
||||||
<@- if param.type.optional @>[<@ endif -@>
|
|
||||||
<$ param.name $>
|
|
||||||
<@- if param.type.optional @>]<@ endif -@>
|
|
||||||
<@ endfor @>)</code><@ if fn.alias @><small>(alias: <$ fn.alias $>)</small><@ endif @>
|
|
||||||
<@ endmacro -@>
|
|
||||||
|
|
||||||
<@- macro typeInfo(fn) -@>
|
|
||||||
<$ typeList(fn.typeList) $> <$ fn.description $>
|
|
||||||
<@- endmacro -@>
|
|
||||||
26
scripts/docs/templates/lib/methods.template.html
vendored
26
scripts/docs/templates/lib/methods.template.html
vendored
@ -1,26 +0,0 @@
|
|||||||
<@- if doc.methods @>
|
|
||||||
## Methods
|
|
||||||
<@- for method in doc.methods @>
|
|
||||||
|
|
||||||
<div id="<$ method.name $>"></div>
|
|
||||||
<h2>
|
|
||||||
<$ functionSyntax(method) $>
|
|
||||||
</h2>
|
|
||||||
|
|
||||||
<$ method.description $>
|
|
||||||
|
|
||||||
<@ if method.params @>
|
|
||||||
<$ paramTable(method.params) $>
|
|
||||||
<@ endif @>
|
|
||||||
|
|
||||||
<@ if method.this @>
|
|
||||||
#### Method's `this`
|
|
||||||
<$ method.this $>
|
|
||||||
<@ endif @>
|
|
||||||
|
|
||||||
<@ if method.returns @>
|
|
||||||
* Returns: <$ typeInfo(method.returns) $>
|
|
||||||
<@ endif @>
|
|
||||||
|
|
||||||
<@ endfor -@>
|
|
||||||
<@- endif -@>
|
|
||||||
@ -1,14 +0,0 @@
|
|||||||
<@- if doc.properties @>
|
|
||||||
<h2 id="properties">Properties</h2>
|
|
||||||
<@- for property in doc.properties @>
|
|
||||||
|
|
||||||
<div id="<$ property.name $>"></div>
|
|
||||||
* <h3><$ typeList(property.returns.typeList) $> <code><$ property.name $></code></h3>
|
|
||||||
|
|
||||||
<$ property.returns.description $>
|
|
||||||
|
|
||||||
<$ property.description $>
|
|
||||||
|
|
||||||
<@ endfor -@>
|
|
||||||
</ul>
|
|
||||||
<@- endif -@>
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
<@ if doc.returns -@>
|
|
||||||
<h3>Returns</h3>
|
|
||||||
<$ typeInfo(doc.returns) $>
|
|
||||||
<@- endif @>
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
<@ if doc.this @>
|
|
||||||
<h3>Method's <@ code @>this<@ endcode @></h3>
|
|
||||||
<$ doc.this | marked $>
|
|
||||||
<@ endif @>
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
layout: "v2/docs_base"
|
|
||||||
version: "<$ version.current.name $>"
|
|
||||||
versionHref: "<$ version.current.href $>"
|
|
||||||
path: "<$ doc.path $>"
|
|
||||||
5
scripts/docs/templates/module.template.html
vendored
5
scripts/docs/templates/module.template.html
vendored
@ -1,5 +0,0 @@
|
|||||||
<h1>{$ doc.id $}</h1>
|
|
||||||
|
|
||||||
{%- for export in doc.exports %}
|
|
||||||
<a href="/ionic-site/docs/{$ export.outputPath $}">{$ export.name $}</a></br>
|
|
||||||
{% endfor %}
|
|
||||||
Reference in New Issue
Block a user