mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2026-03-13 10:22:08 +08:00
docs wip
This commit is contained in:
@@ -9,12 +9,15 @@ var path = require('path');
|
||||
// Define the dgeni package for generating the docs
|
||||
module.exports = new Package('ionic-v2-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage, gitPackage])
|
||||
|
||||
//for debugging docs
|
||||
// for debugging docs
|
||||
// .processor(function test(){
|
||||
// return {
|
||||
// $runAfter: ['files-written'],
|
||||
// $process: function(docs){
|
||||
// docs.forEach(function(doc){
|
||||
// if (doc.constructorDoc){
|
||||
// debugger;
|
||||
// }
|
||||
// })
|
||||
// }
|
||||
// }
|
||||
|
||||
8
scripts/docs/templates/common.template.html
vendored
8
scripts/docs/templates/common.template.html
vendored
@@ -1,6 +1,6 @@
|
||||
{% macro paramList(params) -%}
|
||||
{%- if params -%}<span class="params">(
|
||||
{%- for param in params -%}
|
||||
{% macro paramList(paramData) -%}
|
||||
{%- if paramData -%}<span class="params">(
|
||||
{%- for param in paramData -%}
|
||||
<span class="param">{$ param | escape $}{% if not loop.last %}, {% endif %}</span>
|
||||
{%- endfor %})</span>
|
||||
{%- endif %}
|
||||
@@ -28,7 +28,7 @@ defined in {$ githubViewLink(doc) $}
|
||||
|
||||
{%- if doc.constructorDoc %}
|
||||
<section class="member constructor">
|
||||
<h1 id="constructor" class="name">{$ doc.constructorDoc.name $}{$ paramList(doc.constructorDoc.params) $}</h1>
|
||||
<h1 id="constructor" class="name">{$ doc.constructorDoc.name $}{$ paramList(doc.constructorDoc.paramData) $}</h1>
|
||||
{% marked %}
|
||||
{$ doc.constructorDoc.description $}
|
||||
{% endmarked %}
|
||||
|
||||
2
scripts/docs/templates/module.template.html
vendored
2
scripts/docs/templates/module.template.html
vendored
@@ -1,5 +1,5 @@
|
||||
<h1>{$ doc.id $}</h1>
|
||||
|
||||
{%- for export in doc.exports %}
|
||||
<a href="/docs/{$ export.outputPath $}">{$ export.name $}</a>
|
||||
<a href="/docs/{$ export.outputPath $}">{$ export.name $}</a></br>
|
||||
{% endfor %}
|
||||
|
||||
Reference in New Issue
Block a user